{ "openapi": "3.0.4", "info": { "title": "Session Recording Rest Api Service", "version": "v1" }, "servers": [ { "url": "https://srs.apps.cloud.com", "description": "For customers in US region" }, { "url": "https://srs-eu.apps.cloud.com", "description": "For customers in EU region" }, { "url": "https://srs-ap-s.apps.cloud.com", "description": "For customers in APS region" }, { "url": "https://srs.apps.citrixcloud.jp", "description": "For customers in JP region" } ], "paths": { "/api/aadcache/groupoids": { "get": { "tags": [ "AADCache" ], "summary": "Get groupoids aadcache", "operationId": "AADCache_Get_Groupoids_Aadcache", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/aadcache/groupnames": { "post": { "tags": [ "AADCache" ], "summary": "Post groupnames aadcache", "operationId": "AADCache_Post_Groupnames_Aadcache", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SyncGroupDisplayNameBodyPerSite" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/featuretoggle/cloud": { "get": { "tags": [ "AADCache" ], "summary": "Get cloud featuretoggle", "operationId": "AADCache_Get_Cloud_Featuretoggle", "parameters": [ { "name": "featureName", "in": "header", "schema": { "type": "string" } }, { "name": "scopeCustomerId", "in": "header", "schema": { "type": "string" } }, { "name": "scopeSiteId", "in": "header", "schema": { "type": "string" } }, { "name": "scopeServerId", "in": "header", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "AADCache" ], "summary": "Post cloud featuretoggle", "operationId": "AADCache_Post_Cloud_Featuretoggle", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "AADCache" ], "summary": "Delete cloud featuretoggle", "operationId": "AADCache_Delete_Cloud_Featuretoggle", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/CloudFeatureToggleRecord" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/aiAnalyzer/configuration/names": { "get": { "tags": [ "AIAnalyzer" ], "summary": "Get names configuration aiAnalyzer", "operationId": "AIAnalyzer_Get_Names_Configuration_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/xml": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/xml": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/aiAnalyzer/configuration": { "get": { "tags": [ "AIAnalyzer" ], "summary": "Get configuration aiAnalyzer", "operationId": "AIAnalyzer_Get_Configuration_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AIConfigurationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AIConfigurationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIConfigurationModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIConfigurationModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIConfigurationModel" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "AIAnalyzer" ], "summary": "Post configuration aiAnalyzer", "operationId": "AIAnalyzer_Post_Configuration_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AIConfigurationRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } } } } }, "/api/aiAnalyzer/task": { "get": { "tags": [ "AIAnalyzer" ], "summary": "Get task aiAnalyzer", "operationId": "AIAnalyzer_Get_Task_Aianalyzer", "parameters": [ { "name": "taskID", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "AIAnalyzer" ], "summary": "Post task aiAnalyzer", "operationId": "AIAnalyzer_Post_Task_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } } } } }, "/api/aiAnalyzer/tasks": { "post": { "tags": [ "AIAnalyzer" ], "summary": "Post tasks aiAnalyzer", "operationId": "AIAnalyzer_Post_Tasks_Aianalyzer", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskQueryModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskPageModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskPageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskPageModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIAnalyzeTaskPageModel" } } } }, "404": { "description": "Not Found" } } } }, "/api/aiAnalyzer/task/output": { "get": { "tags": [ "AIAnalyzer" ], "summary": "Get output task aiAnalyzer", "operationId": "AIAnalyzer_Get_Output_Task_Aianalyzer", "parameters": [ { "name": "taskID", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } } } }, "/api/aiAnalyzer/prompt": { "get": { "tags": [ "AIAnalyzer" ], "summary": "Get prompt aiAnalyzer", "operationId": "AIAnalyzer_Get_Prompt_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIPromptModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIPromptModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIPromptModel" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIPromptModel" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIPromptModel" } } } } } } }, "post": { "tags": [ "AIAnalyzer" ], "summary": "Post prompt aiAnalyzer", "operationId": "AIAnalyzer_Post_Prompt_Aianalyzer", "parameters": [ { "name": "analyzerID", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AIPromptModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } } } } }, "/api/aiAnalyzer/prompt/{promptID}": { "delete": { "tags": [ "AIAnalyzer" ], "summary": "Delete promptID prompt aiAnalyzer", "operationId": "AIAnalyzer_Delete_Promptid_Prompt_Aianalyzer", "parameters": [ { "name": "promptID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/recordings/archived": { "get": { "tags": [ "ArchiveDelete" ], "summary": "Get archived recordings", "operationId": "ArchiveDelete_Get_Archived_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get All Recordings Without Conditions Ordered By Created Time Of Recordings" }, "/api/recordings/archived/$search": { "post": { "tags": [ "ArchiveDelete" ], "summary": "search archived recordings", "operationId": "ArchiveDelete_search_archived_recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/recordingPath/$check": { "post": { "tags": [ "ArchiveDelete" ], "summary": "check recordingPath", "operationId": "ArchiveDelete_check_recordingPath", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "FileId", "in": "header", "description": "ICL file id without prefix i_ and extension", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get Recording File Absolute Physical Path" }, "/api/recordings": { "patch": { "tags": [ "ArchiveDelete" ], "summary": "Patch recordings", "operationId": "ArchiveDelete_Patch_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archiveParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/archiveParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/archiveParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/archiveParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/archiveParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/archiveParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "ArchiveDelete" ], "summary": "Delete recordings", "operationId": "ArchiveDelete_Delete_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/deleteParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/deleteParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/deleteParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/deleteParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/deleteParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "CloudInterface" ], "summary": "Get recordings", "operationId": "CloudInterface_Get_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/events": { "get": { "tags": [ "AsyncTask" ], "summary": "Get events", "operationId": "AsyncTask_Get_Events", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventBase" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventBase" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventBase" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventBase" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventBase" } } } } } } }, "delete": { "tags": [ "AsyncTask" ], "summary": "Delete events", "operationId": "AsyncTask_Delete_Events", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteEventParam" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } } } } }, "/api/tasks/{taskID}": { "get": { "tags": [ "AsyncTask" ], "summary": "Get taskID tasks", "operationId": "AsyncTask_Get_Taskid_Tasks", "parameters": [ { "name": "taskID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "actionOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AsyncTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AsyncTask" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "AsyncTask" ], "summary": "Patch taskID tasks", "operationId": "AsyncTask_Patch_Taskid_Tasks", "parameters": [ { "name": "taskID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TaskUpdateParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/tasks": { "get": { "tags": [ "AsyncTask" ], "summary": "Get tasks", "operationId": "AsyncTask_Get_Tasks", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "AsyncTask" ], "summary": "Patch tasks", "operationId": "AsyncTask_Patch_Tasks", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/xml": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/xml": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } } } } }, "/api/tasks/$search": { "post": { "tags": [ "AsyncTask" ], "summary": "search tasks", "operationId": "AsyncTask_search_tasks", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TaskSearchParam" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncTask" } } } } } } } }, "/api/site/policy": { "get": { "tags": [ "AsyncTask" ], "summary": "Get site storage policy", "operationId": "AsyncTask_Get_Policy_Site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePolicy" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePolicy" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePolicy" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePolicy" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePolicy" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "AsyncTask" ], "summary": "Post site storage policy", "operationId": "AsyncTask_Post_Policy_Site", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } }, "application/xml": { "schema": { } }, "text/xml": { "schema": { } }, "application/*+xml": { "schema": { } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/policy/{policyId}": { "patch": { "tags": [ "AsyncTask" ], "summary": "Patch site storage policy by id", "operationId": "AsyncTask_Patch_Policyid_Policy_Site", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "newName", "in": "query", "schema": { "type": "string" } }, { "name": "newDescription", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } }, "application/xml": { "schema": { } }, "text/xml": { "schema": { } }, "application/*+xml": { "schema": { } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/identity/userproviders": { "get": { "tags": [ "AzureActiveDirectory" ], "summary": "Get userproviders identity", "operationId": "AzureActiveDirectory_Get_Userproviders_Identity", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AllProviderStatusRoot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AllProviderStatusRoot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AllProviderStatusRoot" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AllProviderStatusRoot" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AllProviderStatusRoot" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/search/azureactivedirectory": { "get": { "tags": [ "AzureActiveDirectory" ], "summary": "Get azureactivedirectory search", "operationId": "AzureActiveDirectory_Get_Azureactivedirectory_Search", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CloudDirectoriesModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloudDirectoriesModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudDirectoriesModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CloudDirectoriesModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CloudDirectoriesModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/identity/azureactivedirectory": { "post": { "tags": [ "AzureActiveDirectory" ], "summary": "Post azureactivedirectory identity", "operationId": "AzureActiveDirectory_Post_Azureactivedirectory_Identity", "parameters": [ { "name": "filterbuild", "in": "query", "schema": { "type": "string" } }, { "name": "identityprovider", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AzureActiveDirectoryModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AzureActiveDirectoryModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AzureActiveDirectoryModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AzureActiveDirectoryModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventfileinfo": { "get": { "tags": [ "CloudInterface" ], "summary": "Get eventfileinfo", "operationId": "CloudInterface_Get_Eventfileinfo", "parameters": [ { "name": "eventGuid", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EventFileMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventFileMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventFileMetadata" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventFileMetadata" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventFileMetadata" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/ctxSession/{sessionId}": { "get": { "tags": [ "CloudInterface" ], "summary": "Get sessionId ctxSession", "operationId": "CloudInterface_Get_Sessionid_Ctxsession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventsInfo": { "get": { "tags": [ "CloudInterface" ], "summary": "Get eventsInfo", "operationId": "CloudInterface_Get_Eventsinfo", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "FileId", "in": "header", "description": "ICL file id without prefix i_ and extension", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EventMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventMetadataList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get Events Info With Fileid Ordered By Created Time Of Events" }, "/api/recordingPath": { "get": { "tags": [ "CloudInterface" ], "summary": "Get recordingPath", "operationId": "CloudInterface_Get_Recordingpath", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "FileId", "in": "header", "description": "ICL file id without prefix i_ and extension", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RecordingFile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecordingFile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordingFile" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecordingFile" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/onpremplaybacksource": { "get": { "tags": [ "CloudInterface" ], "summary": "Get onpremplaybacksource", "operationId": "CloudInterface_Get_Onpremplaybacksource", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch onpremplaybacksource", "operationId": "CloudInterface_Patch_Onpremplaybacksource", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OnPremPlaybackSource" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/comments": { "get": { "tags": [ "CloudInterface" ], "summary": "Get comments", "operationId": "CloudInterface_Get_Comments", "parameters": [ { "name": "fileId", "in": "query", "schema": { "type": "string" } }, { "name": "user", "in": "header", "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "fileId", "in": "header", "description": "ICL file id without prefix i_ and extension(Optional)", "schema": { "type": "string" } }, { "name": "user", "in": "header", "description": "Specified user(Optional)", "schema": { "type": "string" } }, { "name": "continuationToken", "in": "header", "description": "The info about next set of items to return", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommentList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommentList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "CloudInterface" ], "summary": "Post comments", "operationId": "CloudInterface_Post_Comments", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PostCommentBodyJSON" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "CloudInterface" ], "summary": "Delete comments", "operationId": "CloudInterface_Delete_Comments", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "user", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "id", "in": "header", "description": "The identifier of comment", "schema": { "type": "string" } }, { "name": "user", "in": "header", "description": "The user who commentated", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommentsResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get Comments With Params Ordered By Created Time Of Comments" }, "/api/playlink": { "get": { "tags": [ "CloudInterface" ], "summary": "Get playlink", "operationId": "CloudInterface_Get_Playlink", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } }, { "name": "UrlVer", "in": "header", "description": "url's version, current value is 1", "required": true, "schema": { "type": "string" } }, { "name": "FileId", "in": "header", "description": "ICL file id without prefix i_ and extension", "required": true, "schema": { "type": "string" } }, { "name": "ExpiredTime", "in": "header", "description": "url's expired time, nanoseconds from 00:00:00.0000000 UTC, January 1, 0001", "schema": { "type": "string" } }, { "name": "SeekTime", "in": "header", "description": "player seek time", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayLink" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlayLink" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get Recording Playlink" }, "/api/policy/{policyId}": { "get": { "tags": [ "CloudInterface" ], "summary": "Get policy by id", "operationId": "CloudInterface_Get_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PolicyDocInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "CloudInterface" ], "summary": "Delete policy by id", "operationId": "CloudInterface_Delete_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch policy by id", "operationId": "CloudInterface_Patch_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "newName", "in": "query", "schema": { "type": "string" } }, { "name": "policyType", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "newDescription", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get a Policy Document for the Policy Document ID Specified" }, "/api/policy/{policyId}/recordrules": { "get": { "tags": [ "CloudInterface" ], "summary": "Get recordrules by policy id", "operationId": "CloudInterface_Get_Recordrules_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordRulePara" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordRulePara" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordRulePara" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordRulePara" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordRulePara" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/eventrules": { "get": { "tags": [ "CloudInterface" ], "summary": "Get eventrules by policy id", "operationId": "CloudInterface_Get_Eventrules_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRulePara" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRulePara" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRulePara" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRulePara" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRulePara" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/alertrules": { "get": { "tags": [ "CloudInterface" ], "summary": "Get alertrules by policy id", "operationId": "CloudInterface_Get_Alertrules_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRulePara" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRulePara" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRulePara" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRulePara" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRulePara" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/endpointrecordrules": { "get": { "tags": [ "CloudInterface" ], "summary": "Get endpointrecordrules by policy id", "operationId": "CloudInterface_Get_Endpointrecordrules_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointRulePara" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointRulePara" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointRulePara" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointRulePara" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndPointRulePara" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy": { "get": { "tags": [ "CloudInterface" ], "summary": "Get policy", "operationId": "CloudInterface_Get_Policy", "parameters": [ { "name": "policyType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocumentInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocumentInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "CloudInterface" ], "summary": "Post policy", "operationId": "CloudInterface_Post_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentParas" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentInfo" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/rules/{customerIdOrSiteName}/{resourceName}": { "get": { "tags": [ "CloudInterface" ], "summary": "Get resourceName customerIdOrSiteName rules", "operationId": "CloudInterface_Get_Resourcename_Customeridorsitename_Rules", "parameters": [ { "name": "customerIdOrSiteName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "isCloud", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "filterName", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocumentInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocumentInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceResponseModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceResponseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceResponseModel" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceResponseModel" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceResponseModel" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get a Policy Rule for the Policy Document ID and rule name Specified" }, "/api/search/applicationDisplayName": { "get": { "tags": [ "CloudInterface" ], "summary": "Get applicationDisplayName search", "operationId": "CloudInterface_Get_Applicationdisplayname_Search", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationName" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationName" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationName" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationName" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationName" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/config/$playbackLogging": { "get": { "tags": [ "CloudInterface" ], "summary": "playbackLogging config", "operationId": "CloudInterface_playbackLogging_config", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "playback logging configuration type", "schema": { "title": "Content-Type", "type": "string", "description": "playback logging configuration type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackConfig" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackConfig" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackConfig" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackConfig" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackConfig" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/playbackReason": { "post": { "tags": [ "CloudInterface" ], "summary": "Post playbackReason", "operationId": "CloudInterface_Post_Playbackreason", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PlaybackReason" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "ServerId type", "schema": { "title": "Content-Type", "type": "string", "description": "ServerId type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/config/serverproperties": { "get": { "tags": [ "CloudInterface" ], "summary": "Get serverproperties config", "operationId": "CloudInterface_Get_Serverproperties_Config", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Server properties configuration type", "schema": { "title": "Content-Type", "type": "string", "description": "Server properties configuration type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/serverPropGetConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/serverPropGetConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/serverPropGetConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/serverPropGetConfig" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/serverPropGetConfig" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch serverproperties config", "operationId": "CloudInterface_Patch_Serverproperties_Config", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Set The Server Properity Configuration" }, "/api/config/siteserverproperties": { "get": { "tags": [ "CloudInterface" ], "summary": "Get siteserverproperties config", "operationId": "CloudInterface_Get_Siteserverproperties_Config", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Server properties configuration type", "schema": { "title": "Content-Type", "type": "string", "description": "Server properties configuration type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServerConfigParas" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfigParas" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServerConfigParas" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ServerConfigParas" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ServerConfigParas" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/rbac": { "get": { "tags": [ "CloudInterface" ], "summary": "Get rbac policy", "operationId": "CloudInterface_Get_Rbac_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "PolicyDocumentInfo type", "schema": { "title": "Content-Type", "type": "string", "description": "PolicyDocumentInfo type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PolicyDocumentList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "CloudInterface" ], "summary": "Post rbac policy", "operationId": "CloudInterface_Post_Rbac_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch rbac policy", "operationId": "CloudInterface_Patch_Rbac_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PlayerUserAccountRolePolicyInfo2" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/installingProgress": { "get": { "tags": [ "CloudInterface" ], "summary": "Get installingProgress", "operationId": "CloudInterface_Get_Installingprogress", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Server properties configuration type", "schema": { "title": "Content-Type", "type": "string", "description": "Server properties configuration type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InstallingProgress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InstallingProgress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InstallingProgress" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InstallingProgress" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InstallingProgress" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$placeRestrictions": { "post": { "tags": [ "CloudInterface" ], "summary": "placeRestrictions", "operationId": "CloudInterface_placeRestrictions", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "ServerId type", "schema": { "title": "Content-Type", "type": "string", "description": "ServerId type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$removeRestrictions": { "post": { "tags": [ "CloudInterface" ], "summary": "removeRestrictions", "operationId": "CloudInterface_removeRestrictions", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RestrictedParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "ServerId type", "schema": { "title": "Content-Type", "type": "string", "description": "ServerId type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$search": { "post": { "tags": [ "CloudInterface" ], "summary": "Search for normal session recordings", "operationId": "CloudInterface_Search_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "x-summary": "Get Recordings With Search Conditions Ordered By Created Time Of Recordings" }, "/api/$searchRestricted": { "post": { "tags": [ "CloudInterface" ], "summary": "Search for restricted session recordings", "operationId": "CloudInterface_Search_Restricted_Recordings", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/NormalSearchQueryParametersWithAbsoluteTimeAndSwagger" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileMetadataList" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/recordrule": { "post": { "tags": [ "CloudInterface" ], "summary": "Post recordrule by policy id", "operationId": "CloudInterface_Post_Recordrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch recordrule by policy id", "operationId": "CloudInterface_Patch_Recordrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleName", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RecordRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/eventrule": { "post": { "tags": [ "CloudInterface" ], "summary": "Post eventrule by policy id", "operationId": "CloudInterface_Post_Eventrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch eventrule by policy id", "operationId": "CloudInterface_Patch_Eventrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleName", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EventRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/alertrule": { "post": { "tags": [ "CloudInterface" ], "summary": "Post alertrule by policy id", "operationId": "CloudInterface_Post_Alertrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "alert policy rule type", "schema": { "title": "Content-Type", "type": "application/json", "description": "alert policy rule type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch alertrule by policy id", "operationId": "CloudInterface_Patch_Alertrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleName", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AlertRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/endpointrecordrule": { "post": { "tags": [ "CloudInterface" ], "summary": "Post endpointrecordrule by policy id", "operationId": "CloudInterface_Post_Endpointrecordrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "CloudInterface" ], "summary": "Patch endpointrecordrule by policy id", "operationId": "CloudInterface_Patch_Endpointrecordrule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleName", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EndPointRulePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$saveSrServerVersion": { "post": { "tags": [ "CloudInterface" ], "summary": "saveSrServerVersion", "operationId": "CloudInterface_saveSrServerVersion", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SaveSrServerVersionInfoRequest" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringCommonResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringCommonResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringCommonResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringCommonResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringCommonResponse" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnose/cdflog": { "post": { "tags": [ "CloudInterface" ], "summary": "Post cdflog diagnose", "operationId": "CloudInterface_Post_Cdflog_Diagnose", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCDFTraceRecord" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnose/sqlcpulog": { "post": { "tags": [ "CloudInterface" ], "summary": "Post sqlcpulog diagnose", "operationId": "CloudInterface_Post_Sqlcpulog_Diagnose", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLCpuLog" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnose/sqllog": { "post": { "tags": [ "CloudInterface" ], "summary": "Post sqllog diagnose", "operationId": "CloudInterface_Post_Sqllog_Diagnose", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremSQLLogRecord" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/sqlLogConfig": { "get": { "tags": [ "CloudInterface" ], "summary": "Get sqlLogConfig", "operationId": "CloudInterface_Get_Sqllogconfig", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$EnableSqlLog": { "post": { "tags": [ "CloudInterface" ], "summary": "EnableSqlLog", "operationId": "CloudInterface_EnableSqlLog", "parameters": [ { "name": "enableSQLLog", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$webstreamingtest": { "post": { "tags": [ "CloudInterface" ], "summary": "webstreamingtest", "operationId": "CloudInterface_webstreamingtest", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/{policyId}/rule": { "delete": { "tags": [ "CloudInterface" ], "summary": "Delete rule by policy id", "operationId": "CloudInterface_Delete_Rule_Policyid_Policy", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleName", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/capability": { "patch": { "tags": [ "CloudInterface" ], "summary": "Patch capability", "operationId": "CloudInterface_Patch_Capability", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/ClientUpgradeModel" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/clientUpgradeNow": { "post": { "tags": [ "CloudInterface" ], "summary": "Post clientUpgradeNow", "operationId": "CloudInterface_Post_Clientupgradenow", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "ServerId type", "schema": { "title": "Content-Type", "type": "string", "description": "ServerId type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/onpremEmailsetting": { "patch": { "tags": [ "CloudInterface" ], "summary": "Patch onpremEmailsetting", "operationId": "CloudInterface_Patch_Onprememailsetting", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EmailAlertNotificationSetting" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/storagelocations": { "get": { "tags": [ "Dashboard" ], "summary": "Get storagelocations", "operationId": "Dashboard_Get_Storagelocations", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/storage": { "get": { "tags": [ "Dashboard" ], "summary": "Get storage dashboard", "operationId": "Dashboard_Get_Storage_Dashboard", "parameters": [ { "name": "startTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StorageDashboard" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Post storage dashboard", "operationId": "Dashboard_Post_Storage_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUploadData" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/session": { "get": { "tags": [ "Dashboard" ], "summary": "Get session dashboard", "operationId": "Dashboard_Get_Session_Dashboard", "parameters": [ { "name": "startTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionDashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionDashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionDashboard" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SessionDashboard" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SessionDashboard" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Post session dashboard", "operationId": "Dashboard_Post_Session_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionUploadData" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/session/{sessionEndFileId}": { "get": { "tags": [ "Dashboard" ], "summary": "Get session by sessionEndFileId", "operationId": "Dashboard_Get_Sessionendfileid_Session_Dashboard", "parameters": [ { "name": "sessionEndFileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SessionDetail" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SessionDetail" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/client": { "get": { "tags": [ "Dashboard" ], "summary": "Get client dashboard", "operationId": "Dashboard_Get_Client_Dashboard", "parameters": [ { "name": "startTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ClientData" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ClientData" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Post client dashboard", "operationId": "Dashboard_Post_Client_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/ClientUploadData" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/serverperfdata": { "get": { "tags": [ "Dashboard" ], "summary": "Get serverperfdata dashboard", "operationId": "Dashboard_Get_Serverperfdata_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Server properties configuration type", "schema": { "title": "Content-Type", "type": "string", "description": "Server properties configuration type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Post serverperfdata dashboard", "operationId": "Dashboard_Post_Serverperfdata_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceRecord" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/$requestUpload": { "post": { "tags": [ "Dashboard" ], "summary": "requestUpload dashboard", "operationId": "Dashboard_requestUpload_dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RequestStatisticParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/settings": { "get": { "tags": [ "Dashboard" ], "summary": "Get settings dashboard", "operationId": "Dashboard_Get_Settings_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Dashboard" ], "summary": "Post settings dashboard", "operationId": "Dashboard_Post_Settings_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "Dashboard" ], "summary": "Patch settings dashboard", "operationId": "Dashboard_Patch_Settings_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DashboardSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/playbackHistory": { "get": { "tags": [ "Dashboard" ], "summary": "Get playbackHistory dashboard", "operationId": "Dashboard_Get_Playbackhistory_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlaybackHistoryDashboardStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlaybackHistoryDashboardStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlaybackHistoryDashboardStatistics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlaybackHistoryDashboardStatistics" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dashboard/agents": { "get": { "tags": [ "Dashboard" ], "summary": "Get agents dashboard", "operationId": "Dashboard_Get_Agents_Dashboard", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgentDashaboardStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgentDashaboardStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentDashaboardStatistics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AgentDashaboardStatistics" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AgentDashaboardStatistics" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/event/uploadSettings": { "get": { "tags": [ "DataProcess" ], "summary": "Get uploadSettings event dataprocess", "operationId": "DataProcess_Get_Uploadsettings_Event_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "DataProcess" ], "summary": "Post uploadSettings event dataprocess", "operationId": "DataProcess_Post_Uploadsettings_Event_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EventUploadSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/event/integrationSettings": { "get": { "tags": [ "DataProcess" ], "summary": "Get integrationSettings event dataprocess", "operationId": "DataProcess_Get_Integrationsettings_Event_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/$saveEventIntegrationSettings": { "post": { "tags": [ "DataProcess" ], "summary": "saveEventIntegrationSettings dataprocess", "operationId": "DataProcess_saveEventIntegrationSettings_dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "string", "format": "uri" } }, "application/json": { "schema": { "type": "string", "format": "uri" } }, "text/json": { "schema": { "type": "string", "format": "uri" } }, "application/xml": { "schema": { "type": "string", "format": "uri" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/event/statistic": { "get": { "tags": [ "DataProcess" ], "summary": "Get statistic event dataprocess", "operationId": "DataProcess_Get_Statistic_Event_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationSettings" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/event/sasUri": { "get": { "tags": [ "DataProcess" ], "summary": "Get sasUri event dataprocess", "operationId": "DataProcess_Get_Sasuri_Event_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QueueSasResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QueueSasResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QueueSasResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/QueueSasResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/QueueSasResponse" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/lib": { "get": { "tags": [ "DataProcess" ], "summary": "Get lib incidentDetection dataprocess", "operationId": "DataProcess_Get_Lib_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentLib" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentLib" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentLib" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentLib" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/libSettings": { "post": { "tags": [ "DataProcess" ], "summary": "Post libSettings incidentDetection dataprocess", "operationId": "DataProcess_Post_Libsettings_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentDefinitionSettings" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/settings": { "get": { "tags": [ "DataProcess" ], "summary": "Get settings incidentDetection dataprocess", "operationId": "DataProcess_Get_Settings_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "DataProcess" ], "summary": "Post settings incidentDetection dataprocess", "operationId": "DataProcess_Post_Settings_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/IncidentSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/settingsAll": { "get": { "tags": [ "DataProcess" ], "summary": "Get settingsAll incidentDetection dataprocess", "operationId": "DataProcess_Get_Settingsall_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentSettings" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/incidents": { "post": { "tags": [ "DataProcess" ], "summary": "Post incidents incidentDetection dataprocess", "operationId": "DataProcess_Post_Incidents_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentListInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentListInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentListInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentListInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IncidentListInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/playBack/{fileId}": { "get": { "tags": [ "DataProcess" ], "summary": "Get fileId playBack incidentDetection dataprocess", "operationId": "DataProcess_Get_Fileid_Playback_Incidentdetection_Dataprocess", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/incidentDetection/report": { "post": { "tags": [ "DataProcess" ], "summary": "Post report incidentDetection dataprocess", "operationId": "DataProcess_Post_Report_Incidentdetection_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/IncidentLimit" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentReportInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentReportInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentReportInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentReportInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IncidentReportInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventReport/ranking": { "post": { "tags": [ "DataProcess" ], "summary": "Post ranking eventReport", "operationId": "DataProcess_Post_Ranking_Eventreport", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatisticInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StatisticInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StatisticInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventReport/barGraph": { "post": { "tags": [ "DataProcess" ], "summary": "Post barGraph eventReport", "operationId": "DataProcess_Post_Bargraph_Eventreport", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventReport/heatMap": { "post": { "tags": [ "DataProcess" ], "summary": "Post heatMap eventReport", "operationId": "DataProcess_Post_Heatmap_Eventreport", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } }, "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } }, "application/xml": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } }, "text/xml": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" } } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/eventReport/eventList": { "post": { "tags": [ "DataProcess" ], "summary": "Post eventList eventReport", "operationId": "DataProcess_Post_Eventlist_Eventreport", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EventListInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EventListInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventListInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EventListInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EventListInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/customLists": { "get": { "tags": [ "DataProcess" ], "summary": "Get customLists dataprocess", "operationId": "DataProcess_Get_Customlists_Dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomListInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomListInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomListInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomListInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomListInfo" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/defaultCustomList/{customListName}": { "get": { "tags": [ "DataProcess" ], "summary": "Get customListName defaultCustomList dataprocess", "operationId": "DataProcess_Get_Customlistname_Defaultcustomlist_Dataprocess", "parameters": [ { "name": "customListName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/dataprocess/$saveCustomList": { "post": { "tags": [ "DataProcess" ], "summary": "saveCustomList dataprocess", "operationId": "DataProcess_saveCustomList_dataprocess", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomListInfo" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$restartService": { "post": { "tags": [ "Diagnose" ], "summary": "restartService", "operationId": "Diagnose_restartService", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/ServiceNameRequest" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/logRedirectionConfig": { "get": { "tags": [ "Diagnose" ], "summary": "Get logRedirectionConfig", "operationId": "Diagnose_Get_Logredirectionconfig", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$redirectLog": { "post": { "tags": [ "Diagnose" ], "summary": "redirectLog", "operationId": "Diagnose_redirectLog", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/LogRedirectionConfig" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$checkRegistry": { "post": { "tags": [ "Diagnose" ], "summary": "checkRegistry", "operationId": "Diagnose_checkRegistry", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RegistryKeyRequest" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RegistryObject" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$updateRegistry": { "post": { "tags": [ "Diagnose" ], "summary": "updateRegistry", "operationId": "Diagnose_updateRegistry", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RegistryObject" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/RegistryObject" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$collectMetricForServices": { "post": { "tags": [ "Diagnose" ], "summary": "collectMetricForServices", "operationId": "Diagnose_collectMetricForServices", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceMetrics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceMetrics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceMetrics" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ServiceMetrics" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ServiceMetrics" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/machines": { "post": { "tags": [ "Diagnose" ], "summary": "Post machines diagnosticLogging", "operationId": "Diagnose_Post_Machines_Diagnosticlogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/types": { "post": { "tags": [ "Diagnose" ], "summary": "Post types diagnosticLogging", "operationId": "Diagnose_Post_Types_Diagnosticlogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticTypesPara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventTypeCount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventTypeCount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventTypeCount" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventTypeCount" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventTypeCount" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/byType": { "post": { "tags": [ "Diagnose" ], "summary": "Post byType diagnosticLogging", "operationId": "Diagnose_Post_Bytype_Diagnosticlogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTypePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/byTime": { "post": { "tags": [ "Diagnose" ], "summary": "Post byTime diagnosticLogging", "operationId": "Diagnose_Post_Bytime_Diagnosticlogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEventsByTimePara" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticEvents" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/$SetRetentionSetting": { "post": { "tags": [ "Diagnose" ], "summary": "SetRetentionSetting diagnosticLogging", "operationId": "Diagnose_SetRetentionSetting_diagnosticLogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/diagnosticLogging/retentionSetting": { "get": { "tags": [ "Diagnose" ], "summary": "Get retentionSetting diagnosticLogging", "operationId": "Diagnose_Get_Retentionsetting_Diagnosticlogging", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticRetentionSetting" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/email/settings": { "get": { "tags": [ "Email" ], "summary": "Get settings of email notification", "operationId": "Email_Get_Settings_Email", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Email" ], "summary": "Post settings of email notification", "operationId": "Email_Post_Settings_Email", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "Email" ], "summary": "Patch settings of email notification", "operationId": "Email_Patch_Settings_Email", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EmailNotificationSettings" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/email/quotausage": { "get": { "tags": [ "Email" ], "summary": "Get quotausage of email notification", "operationId": "Email_Get_Quotausage_Email", "parameters": [ { "name": "startTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTimeUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailNotificationQuotaUsage" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailNotificationQuotaUsage" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailNotificationQuotaUsage" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailNotificationQuotaUsage" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailNotificationQuotaUsage" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoints": { "get": { "tags": [ "Endpoints" ], "summary": "Get endpoints", "operationId": "Endpoints_Get_Endpoints", "parameters": [ { "name": "authDomain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EndpointsReplyV1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointsReplyV1" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EndpointsReplyV1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointsReplyV1" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/CallHome": { "post": { "tags": [ "Endpoints" ], "summary": "Post CallHome", "operationId": "Endpoints_Post_Callhome", "parameters": [ { "name": "authDomain", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(DsAuth token): CitrixAuth {token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/CallHomeRequestV1" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHomeReplyV1" } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHomeReplyV1" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoint/configurations": { "post": { "tags": [ "Endpoints" ], "summary": "Post configurations endpoint", "operationId": "Endpoints_Post_Configurations_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigResponse" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoint/routepolicy": { "get": { "tags": [ "Endpoints" ], "summary": "Get routepolicy endpoint", "operationId": "Endpoints_Get_Routepolicy_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Endpoints" ], "summary": "Post routepolicy endpoint", "operationId": "Endpoints_Post_Routepolicy_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "Endpoints" ], "summary": "Delete routepolicy endpoint", "operationId": "Endpoints_Delete_Routepolicy_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/EndpointRecordingRoute" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoint/recordingpolicies": { "get": { "tags": [ "Endpoints" ], "summary": "Get recordingpolicies endpoint", "operationId": "Endpoints_Get_Recordingpolicies_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(DsAuth token): CitrixAuth {token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoint/registerSTA": { "get": { "tags": [ "Endpoints" ], "summary": "Get registerSTA endpoint", "operationId": "Endpoints_Get_Registersta_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(DsAuth token): CitrixAuth {token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/endpoint/checksiteeprecordingstate": { "get": { "tags": [ "Endpoints" ], "summary": "Get checksiteeprecordingstate endpoint", "operationId": "Endpoints_Get_Checksiteeprecordingstate_Endpoint", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/exportRecording/srtaskmachine/info": { "get": { "tags": [ "ExportRecording" ], "summary": "Get info srtaskmachine exportRecording", "operationId": "ExportRecording_Get_Info_Srtaskmachine_Exportrecording", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/exportRecording/tasks": { "post": { "tags": [ "ExportRecording" ], "summary": "Post tasks exportRecording", "operationId": "ExportRecording_Post_Tasks_Exportrecording", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TaskRequestModel" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SRTask" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SRTask" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SRTask" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SRTask" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SRTask" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/exportRecording/task": { "post": { "tags": [ "ExportRecording" ], "summary": "Post task exportRecording", "operationId": "ExportRecording_Post_Task_Exportrecording", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } }, "text/json": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/postTaskBodyJSON" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/exportRecordingReason": { "post": { "tags": [ "ExportRecording" ], "summary": "Post exportRecordingReason", "operationId": "ExportRecording_Post_Exportrecordingreason", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/ExportRecordingReason" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/exportRecording/task/{taskID}": { "delete": { "tags": [ "ExportRecording" ], "summary": "Delete taskID task exportRecording", "operationId": "ExportRecording_Delete_Taskid_Task_Exportrecording", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/taskResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/anonymousplaylinkList": { "get": { "tags": [ "PlayBackLink" ], "summary": "Get anonymousplaylinkList", "operationId": "PlayBackLink_Get_Anonymousplaylinklist", "parameters": [ { "name": "fileId", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkList" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/webplayerstatus": { "get": { "tags": [ "PlayBackLink" ], "summary": "Get webplayerstatus", "operationId": "PlayBackLink_Get_Webplayerstatus", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebPlayerInstalled" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebPlayerInstalled" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebPlayerInstalled" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WebPlayerInstalled" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WebPlayerInstalled" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/player/playbackHistory": { "get": { "tags": [ "PlayBackLink" ], "summary": "Get playbackHistory player", "operationId": "PlayBackLink_Get_Playbackhistory_Player", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlaybackActivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlaybackActivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlaybackActivity" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PlaybackActivity" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PlaybackActivity" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/anonymousplaylink": { "post": { "tags": [ "PlayBackLink" ], "summary": "Post anonymousplaylink", "operationId": "PlayBackLink_Post_Anonymousplaylink", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLinkParam" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLink" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLink" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AnonymousPlayLink" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "PlayBackLink" ], "summary": "Patch anonymousplaylink", "operationId": "PlayBackLink_Patch_Anonymousplaylink", "parameters": [ { "name": "fileId", "in": "query", "schema": { "type": "string" } }, { "name": "linkId", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/anonymousplaylinks": { "delete": { "tags": [ "PlayBackLink" ], "summary": "Delete anonymousplaylinks", "operationId": "PlayBackLink_Delete_Anonymousplaylinks", "parameters": [ { "name": "fileId", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonPostResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/getEventTriggerTemplates": { "get": { "tags": [ "PolicyTemplate" ], "summary": "Get getEventTriggerTemplates", "operationId": "PolicyTemplate_Get_Geteventtriggertemplates", "parameters": [ { "name": "SrMinVersion", "in": "query", "schema": { "type": "string", "default": "2203" } }, { "name": "locale", "in": "query", "schema": { "type": "string", "default": "en-US" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/increaseTemplateClickTimes": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post increaseTemplateClickTimes", "operationId": "PolicyTemplate_Post_Increasetemplateclicktimes", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/newTemplates": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post newTemplates", "operationId": "PolicyTemplate_Post_Newtemplates", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } }, "application/*+xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTriggerTemplate" } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/getCustomEventTriggerTemplates": { "get": { "tags": [ "PolicyTemplate" ], "summary": "Get getCustomEventTriggerTemplates", "operationId": "PolicyTemplate_Get_Getcustomeventtriggertemplates", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/getPublishedEventTriggerTemplates": { "get": { "tags": [ "PolicyTemplate" ], "summary": "Get getPublishedEventTriggerTemplates", "operationId": "PolicyTemplate_Get_Getpublishedeventtriggertemplates", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/PublishedEventTriggerTemplates/Status/{status}": { "get": { "tags": [ "PolicyTemplate" ], "summary": "Get status Status PublishedEventTriggerTemplates", "operationId": "PolicyTemplate_Get_Status_Status_Publishedeventtriggertemplates", "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/predefinedTemplateData": { "get": { "tags": [ "PolicyTemplate" ], "summary": "Get predefinedTemplateData", "operationId": "PolicyTemplate_Get_Predefinedtemplatedata", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/deleteCustomEventTriggerTemplate/{id}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete id deleteCustomEventTriggerTemplate", "operationId": "PolicyTemplate_Delete_Id_Deletecustomeventtriggertemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/CustomEventTriggerTemplate/{customerId}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete customerId CustomEventTriggerTemplate", "operationId": "PolicyTemplate_Delete_Customerid_Customeventtriggertemplate", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/PublishedEventTriggerTemplate/{customerId}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete customerId PublishedEventTriggerTemplate", "operationId": "PolicyTemplate_Delete_Customerid_Publishedeventtriggertemplate", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/unlikeTemplate/{id}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete id unlikeTemplate", "operationId": "PolicyTemplate_Delete_Id_Unliketemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/unbookmarkTemplate/{id}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete id unbookmarkTemplate", "operationId": "PolicyTemplate_Delete_Id_Unbookmarktemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/withdrawTemplate/{id}": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete id withdrawTemplate", "operationId": "PolicyTemplate_Delete_Id_Withdrawtemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/saveCustomEventTriggerTemplate": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post saveCustomEventTriggerTemplate", "operationId": "PolicyTemplate_Post_Savecustomeventtriggertemplate", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/publishCustomEventTriggerTemplate": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post publishCustomEventTriggerTemplate", "operationId": "PolicyTemplate_Post_Publishcustomeventtriggertemplate", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublishedEventTriggerTemplate" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emailRecipients": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post of email notificationRecipients", "operationId": "PolicyTemplate_Post_Emailrecipients", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/*+xml": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/likeTemplate/{id}": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post id likeTemplate", "operationId": "PolicyTemplate_Post_Id_Liketemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/bookmarkTemplate/{id}": { "post": { "tags": [ "PolicyTemplate" ], "summary": "Post id bookmarkTemplate", "operationId": "PolicyTemplate_Post_Id_Bookmarktemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/Templates": { "delete": { "tags": [ "PolicyTemplate" ], "summary": "Delete Templates", "operationId": "PolicyTemplate_Delete_Templates", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TemplateID" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/template/{id}": { "patch": { "tags": [ "PolicyTemplate" ], "summary": "Patch id template", "operationId": "PolicyTemplate_Patch_Id_Template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomEventTriggerTemplate" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/template/status": { "patch": { "tags": [ "PolicyTemplate" ], "summary": "Patch status template", "operationId": "PolicyTemplate_Patch_Status_Template", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/PublishedTemplateStatus" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/recording/sessionKeys": { "get": { "tags": [ "RecSucssRateCalc" ], "summary": "Get sessionKeys recording", "operationId": "RecSucssRateCalc_Get_Sessionkeys_Recording", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SessionKeys" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/activeRecordPolicy": { "get": { "tags": [ "RecSucssRateCalc" ], "summary": "Get activeRecordPolicy policy", "operationId": "RecSucssRateCalc_Get_Activerecordpolicy_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/policy/activeEndpointRecordPolicy": { "get": { "tags": [ "RecSucssRateCalc" ], "summary": "Get activeEndpointRecordPolicy policy", "operationId": "RecSucssRateCalc_Get_Activeendpointrecordpolicy_Policy", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ActivePolicyInfo" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/recordSuccessRateTrend/{isManualTrigger}": { "get": { "tags": [ "RecSucssRateCalc" ], "summary": "Get isManualTrigger recordSuccessRateTrend", "operationId": "RecSucssRateCalc_Get_Ismanualtrigger_Recordsuccessratetrend", "parameters": [ { "name": "isManualTrigger", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordSuccessRate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordSuccessRate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordSuccessRate" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordSuccessRate" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordSuccessRate" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/server": { "get": { "tags": [ "ServerSite" ], "summary": "Get server", "operationId": "ServerSite_Get_Server", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServerInfo" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "ServerSite" ], "summary": "Patch server", "operationId": "ServerSite_Patch_Server", "parameters": [ { "name": "siteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "serverId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "serverName", "in": "query", "schema": { "type": "string" } }, { "name": "serverDescription", "in": "query", "schema": { "type": "string" } }, { "name": "notifyClient", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site": { "get": { "tags": [ "ServerSite" ], "summary": "Get site", "operationId": "ServerSite_Get_Site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SiteInfo" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "ServerSite" ], "summary": "Patch site", "operationId": "ServerSite_Patch_Site", "parameters": [ { "name": "siteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "siteName", "in": "query", "schema": { "type": "string" } }, { "name": "siteDescription", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/playbacksource": { "get": { "tags": [ "ServerSite" ], "summary": "Get playbacksource site", "operationId": "ServerSite_Get_Playbacksource_Site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPlaybackSource" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPlaybackSource" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPlaybackSource" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPlaybackSource" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPlaybackSource" } } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "ServerSite" ], "summary": "Patch playbacksource site", "operationId": "ServerSite_Patch_Playbacksource_Site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/CloudPlaybackSource" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "CommonResult type", "schema": { "title": "Content-Type", "type": "string", "description": "CommonResult type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "501": { "description": "Not Implemented", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}": { "delete": { "tags": [ "ServerSite" ], "summary": "Delete siteId site", "operationId": "ServerSite_Delete_Siteid_Site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "204": { "description": "No Content", "headers": { "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/connections": { "get": { "tags": [ "TurnKey" ], "summary": "Get connections", "operationId": "TurnKey_Get_Connections", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TurnKeyConnection" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TurnKeyConnection" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TurnKeyConnection" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TurnKeyConnection" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TurnKeyConnection" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/connection/{connectionId}": { "get": { "tags": [ "TurnKey" ], "summary": "Get connectionId connection", "operationId": "TurnKey_Get_Connectionid_Connection", "parameters": [ { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "TurnKey" ], "summary": "Delete connectionId connection", "operationId": "TurnKey_Delete_Connectionid_Connection", "parameters": [ { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/connection": { "post": { "tags": [ "TurnKey" ], "summary": "Post connection", "operationId": "TurnKey_Post_Connection", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TurnKeyConnection" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$deploy": { "post": { "tags": [ "TurnKey" ], "summary": "deploy site", "operationId": "TurnKey_deploy_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$addResources": { "post": { "tags": [ "TurnKey" ], "summary": "addResources site", "operationId": "TurnKey_addResources_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$updateLoadBalancerSettings": { "post": { "tags": [ "TurnKey" ], "summary": "updateLoadBalancerSettings site", "operationId": "TurnKey_updateLoadBalancerSettings_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/$dismissError": { "post": { "tags": [ "TurnKey" ], "summary": "dismissError siteId site", "operationId": "TurnKey_dismissError_siteId_site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/$cancelDeployment": { "post": { "tags": [ "TurnKey" ], "summary": "cancelDeployment siteId site", "operationId": "TurnKey_cancelDeployment_siteId_site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/deploymentDetails": { "get": { "tags": [ "TurnKey" ], "summary": "Get deploymentDetails siteId site", "operationId": "TurnKey_Get_Deploymentdetails_Siteid_Site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurnKeyDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurnKeyDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurnKeyDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TurnKeyDetails" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/deploymentProgress": { "get": { "tags": [ "TurnKey" ], "summary": "Get deploymentProgress siteId site", "operationId": "TurnKey_Get_Deploymentprogress_Siteid_Site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/cost": { "get": { "tags": [ "TurnKey" ], "summary": "Get cost siteId site", "operationId": "TurnKey_Get_Cost_Siteid_Site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/azure/vnets": { "get": { "tags": [ "TurnKey" ], "summary": "Get vnets azure", "operationId": "TurnKey_Get_Vnets_Azure", "parameters": [ { "name": "connectionid", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/azure/subnets": { "get": { "tags": [ "TurnKey" ], "summary": "Get subnets azure", "operationId": "TurnKey_Get_Subnets_Azure", "parameters": [ { "name": "connectionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "resourceId", "in": "query", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/azure/prices": { "post": { "tags": [ "TurnKey" ], "summary": "Post prices azure", "operationId": "TurnKey_Post_Prices_Azure", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "number", "format": "double" } }, "application/json": { "schema": { "type": "number", "format": "double" } }, "text/json": { "schema": { "type": "number", "format": "double" } }, "application/xml": { "schema": { "type": "number", "format": "double" } }, "text/xml": { "schema": { "type": "number", "format": "double" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/premierSites": { "get": { "tags": [ "TurnKey" ], "summary": "Get premierSites", "operationId": "TurnKey_Get_Premiersites", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } } } }, "201": { "description": "Created", "headers": { "Location": { "description": "Location", "schema": { "title": "Location", "type": "string", "description": "Location" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "Content-type": { "description": "Content-type", "schema": { "title": "Content-type", "type": "string", "description": "Content-type" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PremierSiteInfo" } } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "409": { "description": "Conflict", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "415": { "description": "Unsupported Media Type", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$generateArmTemplate": { "post": { "tags": [ "TurnKey" ], "summary": "generateArmTemplate site", "operationId": "TurnKey_generateArmTemplate_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/{siteId}/$downloadArmTemplate": { "post": { "tags": [ "TurnKey" ], "summary": "downloadArmTemplate siteId site", "operationId": "TurnKey_downloadArmTemplate_siteId_site", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/server/$runPostConfiguration": { "post": { "tags": [ "TurnKey" ], "summary": "runPostConfiguration server", "operationId": "TurnKey_runPostConfiguration_server", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/server/$updatePostConfigurationStatus": { "post": { "tags": [ "TurnKey" ], "summary": "updatePostConfigurationStatus server", "operationId": "TurnKey_updatePostConfigurationStatus_server", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/server/postConfigurationStatus": { "get": { "tags": [ "TurnKey" ], "summary": "Get postConfigurationStatus server", "operationId": "TurnKey_Get_Postconfigurationstatus_Server", "parameters": [ { "name": "taskId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$setUp": { "post": { "tags": [ "TurnKey" ], "summary": "setUp site", "operationId": "TurnKey_setUp_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$checkSetupPrerequisites": { "post": { "tags": [ "TurnKey" ], "summary": "checkSetupPrerequisites site", "operationId": "TurnKey_checkSetupPrerequisites_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/site/$testDatabaseConnection": { "post": { "tags": [ "TurnKey" ], "summary": "testDatabaseConnection site", "operationId": "TurnKey_testDatabaseConnection_site", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonResult" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/$checkVirtualNetwork": { "post": { "tags": [ "TurnKey" ], "summary": "checkVirtualNetwork", "operationId": "TurnKey_checkVirtualNetwork", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "Empty", "schema": { "title": "Content-Type", "type": "string", "description": "Empty" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringTuple" } } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "406": { "description": "Not Acceptable", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/machine/VDAWithSRA": { "post": { "tags": [ "VDAMachine" ], "summary": "Post VDAWithSRA machine", "operationId": "VDAMachine_Post_Vdawithsra_Machine", "parameters": [ { "name": "Citrix-TransactionId", "in": "header", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Citrix Cloud authorization header(Cc Bearer token): CWSAuth Bearer={token}", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-CustomerId", "in": "header", "description": "cutomer id", "required": true, "schema": { "type": "string" } }, { "name": "ServerId", "in": "header", "description": "SR server id", "schema": { "type": "string" } }, { "name": "SiteId", "in": "header", "description": "LB site id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommonRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommonRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommonRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/CommonRequest" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "description": "RecordingFile type", "schema": { "title": "Content-Type", "type": "string", "description": "RecordingFile type" } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "An ETag of the resource", "schema": { "title": "ETag", "type": "string", "description": "An ETag of the resource" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SessionKeys" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SessionKeys" } } } }, "400": { "description": "Bad Request", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "Forbidden", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "Not Found", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "cache-control": { "description": "cache-control", "schema": { "title": "cache-control", "type": "string", "description": "cache-control" } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } }, "Vary": { "description": "Vary", "schema": { "title": "Vary", "type": "string", "description": "Vary" } }, "ETag": { "description": "ETag", "schema": { "title": "ETag", "type": "string", "description": "ETag" } }, "Last-Modified": { "description": "Last-Modified", "schema": { "title": "Last-Modified", "type": "string", "description": "Last-Modified" } }, "Expires": { "description": "Expires", "schema": { "title": "Expires", "type": "string", "description": "Expires" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "500": { "description": "Internal Server Error", "headers": { "Content-Type": { "description": "Tells the type of the content in the request body.", "schema": { "title": "Content-Type", "type": "string", "description": "Tells the type of the content in the request body." } }, "Citrix-TransactionId": { "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system.", "schema": { "title": "Citrix-TransactionId", "type": "string", "description": "Globally-unique identifier (usually a GUID) that allows the flow of a call to be traced through all components within the system." } }, "X-Content-Type-Options": { "schema": { "title": "X-Content-Type-Options", "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } } }, "components": { "schemas": { "AIAnalyzeTaskModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "iclFileId": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "serverId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/SRTaskType" }, "createTime": { "type": "string", "format": "date-time" }, "createTimeUtc": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "startTimeUtc": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "endTimeUtc": { "type": "string", "format": "date-time" }, "userAccountName": { "type": "string", "nullable": true }, "deliveryGroup": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SRTaskStatus" }, "machineName": { "type": "string", "nullable": true }, "filePath": { "type": "string", "nullable": true }, "sha256": { "type": "string", "nullable": true }, "parameters": { "type": "string", "nullable": true }, "recordingDuration": { "type": "integer", "format": "int32" }, "recordingStartTimeUtc": { "type": "string", "format": "date-time" }, "recordingEndTimeUtc": { "type": "string", "format": "date-time" }, "recordingUserName": { "type": "string", "nullable": true }, "recordingUserAAName": { "type": "string", "nullable": true }, "recordingClientName": { "type": "string", "nullable": true }, "recordingServerName": { "type": "string", "nullable": true }, "recordingApplicationName": { "type": "string", "nullable": true }, "textContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIAnalyzeTaskPageModel": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AIAnalyzeTaskModel" }, "nullable": true } }, "additionalProperties": false }, "AIAnalyzeTaskQueryModel": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "aiAnalyzerID": { "type": "integer", "format": "int32", "nullable": true }, "userNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serverNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "recordingStartTime": { "type": "string", "format": "date-time", "nullable": true }, "recordingEndTime": { "type": "string", "format": "date-time", "nullable": true }, "keyword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIAnalyzeTaskRequestModel": { "type": "object", "properties": { "iclFileIDs": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "promptID": { "type": "string", "format": "uuid" }, "customPrompt": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIConfigurationModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "aiAnalyzerID": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIConfigurationRequestModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIPromptModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "settings": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AbsoluteTimeQueryCondition": { "type": "object", "properties": { "afterServerTimeTicks": { "type": "integer", "format": "int64" }, "beforeServerTimeTicks": { "type": "integer", "format": "int64" }, "fullTimeOfDayMask": { "type": "integer", "format": "int64", "readOnly": true }, "afternoonMask": { "type": "integer", "format": "int64" }, "dayOfWeekMask": { "$ref": "#/components/schemas/dayOfWeek" }, "morningMask": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Action": { "type": "object", "properties": { "target": { "nullable": true, "readOnly": true }, "method": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "ActivePolicyInfo": { "type": "object", "properties": { "systemDefined": { "type": "boolean" }, "policyFile": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentDashaboardStatistics": { "type": "object", "properties": { "deliveryGroupCount": { "type": "integer", "format": "int32" }, "totalAgentCount": { "type": "integer", "format": "int32" }, "activeAgentCount": { "type": "integer", "format": "int32" }, "deliveryGroups": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryGroupStatistics" }, "nullable": true } }, "additionalProperties": false }, "AlertRulePara": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sessionStartAlert": { "type": "boolean" }, "sessionEventResponse": { "type": "boolean" }, "lossyVideoCodecEvent": { "type": "boolean" }, "emailRecipients": { "type": "string", "nullable": true }, "screenRecordTimeInMinutes": { "type": "integer", "format": "int32" }, "preRecordingTimeInSeconds": { "type": "integer", "format": "int32" }, "sessionOpsTimeInSeconds": { "type": "integer", "format": "int32" }, "appStartTrigger": { "type": "string", "nullable": true }, "appEndTrigger": { "type": "string", "nullable": true }, "fileCreateTrigger": { "type": "string", "nullable": true }, "fileDeleteTrigger": { "type": "string", "nullable": true }, "fileMoveTrigger": { "type": "string", "nullable": true }, "fileRenameTrigger": { "type": "string", "nullable": true }, "topMostTrigger": { "type": "string", "nullable": true }, "webAcessTrigger": { "type": "string", "nullable": true }, "cdmusbDriveTrigger": { "type": "string", "nullable": true }, "genericUSBDriveTrigger": { "type": "string", "nullable": true }, "idleTrigger": { "type": "string", "nullable": true }, "fileTransferTrigger": { "type": "string", "nullable": true }, "registryCreateTrigger": { "type": "string", "nullable": true }, "registryDeleteTrigger": { "type": "string", "nullable": true }, "registrySetValueTrigger": { "type": "string", "nullable": true }, "registryDeleteValueTrigger": { "type": "string", "nullable": true }, "registryRenameTrigger": { "type": "string", "nullable": true }, "userAccountModificationTrigger": { "type": "string", "nullable": true }, "unexpectedAppExitTrigger": { "type": "string", "nullable": true }, "appNotRespondingTrigger": { "type": "string", "nullable": true }, "newAppInstalledTrigger": { "type": "string", "nullable": true }, "appUninstalledTrigger": { "type": "string", "nullable": true }, "rdpConnectionTrigger": { "type": "string", "nullable": true }, "clipboardTrigger": { "type": "string", "nullable": true }, "popupWindowsTrigger": { "type": "string", "nullable": true }, "perfDataTrigger": { "type": "string", "nullable": true }, "printTrigger": { "type": "string", "nullable": true }, "ruleName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "clientIPs": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "usersOrGroups": { "type": "string", "nullable": true }, "publishedResources": { "type": "string", "nullable": true }, "deliveryGroupsOrMachines": { "type": "string", "nullable": true }, "cloudDDC": { "type": "boolean" }, "deliveryControllerAddress": { "type": "string", "nullable": true }, "userOid": { "type": "string", "nullable": true }, "groupOid": { "type": "string", "nullable": true }, "aadUsersOrGroups": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertTemplate": { "type": "object", "properties": { "eventType": { "type": "string", "nullable": true }, "template": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AllProviderStatusRoot": { "type": "object", "properties": { "identityProviderEnabled": { "$ref": "#/components/schemas/IdentityProviderEnabled" }, "azureADProviderBasicInfos": { "type": "array", "items": { "$ref": "#/components/schemas/AzureADProviderBasicInfo" }, "nullable": true } }, "additionalProperties": false }, "AnonymousPlayLink": { "type": "object", "additionalProperties": false }, "AnonymousPlayLinkList": { "type": "object", "additionalProperties": false }, "AnonymousPlayLinkParam": { "type": "object", "properties": { "fileId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "seekTime": { "type": "string", "nullable": true }, "justification": { "type": "string", "nullable": true }, "expiredTime": { "type": "string", "nullable": true }, "baseUrl": { "type": "string", "nullable": true }, "sharedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplicationName": { "type": "object", "properties": { "appDisplayName": { "type": "string", "nullable": true }, "appBrowserName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "AssociatedIncidentDefiniton": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "relationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AsyncTask": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createTimeUtc": { "type": "string", "format": "date-time" }, "statusTimeUtc": { "type": "string", "format": "date-time" }, "initiator": { "type": "string", "nullable": true }, "assignee": { "$ref": "#/components/schemas/TaskAssignInfo" }, "type": { "$ref": "#/components/schemas/TaskType" }, "status": { "$ref": "#/components/schemas/AsyncTaskStatus" }, "logs": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AsyncTaskStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "AzureADProviderBasicInfo": { "type": "object", "properties": { "idpInstanceId": { "type": "string", "nullable": true }, "idpNickname": { "type": "string", "nullable": true }, "authDomainName": { "type": "string", "nullable": true }, "authDomainDisplayName": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureActiveDirectoryModel": { "type": "object", "properties": { "identityProvider": { "type": "string", "nullable": true }, "userIdentity": { "$ref": "#/components/schemas/UserIdentity" }, "groupsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/SingleGroupInfo" }, "nullable": true }, "tenantId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureDatabase": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "pricingTier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureGroupObject": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "oid": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "directoryContext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureLoadBalancer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "dnsName": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureStorageLocation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "maxCapacity": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AzureUserObject": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "upn": { "type": "string", "nullable": true }, "oid": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CCDirectoryObjectQueryResultModel": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/Identity" }, "type": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" }, "nullable": true }, "propertiesEx": { "$ref": "#/components/schemas/PropertiesEx" }, "directoryContext": { "$ref": "#/components/schemas/DirectoryContext" } }, "additionalProperties": false }, "CPUMemUsage": { "type": "object", "properties": { "cpu": { "type": "string", "nullable": true }, "memory": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CallHomeReplyV1": { "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/ServiceState" } }, "additionalProperties": false }, "CallHomeRequestV1": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CallingConventions": { "enum": [ 1, 2, 3, 32, 64 ], "type": "integer", "format": "int32" }, "ClientData": { "type": "object", "properties": { "clientDeviceDatas": { "type": "array", "items": { "$ref": "#/components/schemas/ClientDeviceData" }, "nullable": true }, "clientVersionDatas": { "type": "array", "items": { "$ref": "#/components/schemas/ClientVersionData" }, "nullable": true } }, "additionalProperties": false }, "ClientDeviceData": { "type": "object", "properties": { "siteID": { "type": "string", "format": "uuid" }, "customerID": { "type": "string", "nullable": true }, "deviceName": { "type": "string", "nullable": true }, "clientNumber": { "type": "integer", "format": "int32" }, "startTimeUTC": { "type": "string", "format": "date-time" }, "endTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ClientDeviceUploadData": { "type": "object", "properties": { "siteID": { "type": "string", "format": "uuid" }, "customerID": { "type": "string", "nullable": true }, "deviceNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "startTimeUTC": { "type": "string", "format": "date-time" }, "endTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ClientUpgradeModel": { "type": "object", "properties": { "startTime": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ClientUploadData": { "type": "object", "properties": { "clientDeviceDatas": { "type": "array", "items": { "$ref": "#/components/schemas/ClientDeviceUploadData" }, "nullable": true }, "clientVersionDatas": { "type": "array", "items": { "$ref": "#/components/schemas/ClientVersionData" }, "nullable": true } }, "additionalProperties": false }, "ClientVersionData": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "siteID": { "type": "string", "format": "uuid" }, "customerID": { "type": "string", "nullable": true }, "workspaceAppVersion": { "type": "string", "nullable": true }, "sessionNumber": { "type": "integer", "format": "int32" }, "startTimeUTC": { "type": "string", "format": "date-time" }, "endTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CloudDirectoriesModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CCDirectoryObjectQueryResultModel" }, "nullable": true }, "next": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloudFeatureToggleRecord": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "featureName": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "scopeAll": { "type": "boolean" }, "scopeCustomerId": { "type": "string", "nullable": true }, "scopeSiteId": { "type": "string", "nullable": true }, "scopeServerId": { "type": "string", "nullable": true }, "createBy": { "type": "string", "nullable": true }, "createTimeUTC": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloudPlaybackSource": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid" }, "cloudServicePlayerEnabled": { "type": "boolean" }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Comment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fileId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "modifiedUserId": { "type": "string", "format": "uuid" }, "serverId": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "level": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "commentText": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "commentTime": { "type": "integer", "format": "int64" }, "insertTime": { "type": "string", "format": "date-time" }, "insertTimeUTC": { "type": "string", "format": "date-time" }, "modifiedTime": { "type": "string", "format": "date-time" }, "modifiedTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CommentList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" }, "nullable": true } }, "additionalProperties": false }, "CommentsResult": { "type": "object", "properties": { "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommonPostResult": { "type": "object", "properties": { "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommonRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32" }, "offSet": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CommonResult": { "type": "object", "properties": { "response": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConfigResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "storeFronts": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointStoreFront" }, "nullable": true }, "stas": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointSta" }, "nullable": true }, "serverConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointServerConfig" }, "nullable": true }, "gateways": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointGateway" }, "nullable": true } }, "additionalProperties": false }, "ConstructorInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "$ref": "#/components/schemas/Type" }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "$ref": "#/components/schemas/Type" }, "value": { "nullable": true } }, "additionalProperties": false }, "CustomEventTriggerTemplate": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "createdUser": { "type": "string", "nullable": true }, "modifiedUser": { "type": "string", "nullable": true }, "userDisplayName": { "type": "string", "nullable": true }, "modifiedUserDisplayName": { "type": "string", "nullable": true }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/AlertTemplate" }, "nullable": true }, "eventTypeTag": { "type": "string", "nullable": true }, "contexturalTag": { "type": "string", "nullable": true }, "createdTimeutc": { "type": "string", "format": "date-time" }, "modifiedTimeUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CustomListInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "listName": { "type": "string", "nullable": true }, "itemType": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "isDefaultEmpty": { "type": "boolean" }, "parentCustomListId": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "string" }, "nullable": true }, "incidentDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedIncidentDefiniton" }, "nullable": true } }, "additionalProperties": false }, "CustomerEndpoint": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DashboardServerPerformanceData": { "type": "object", "properties": { "cpuUsage": { "type": "integer", "format": "int32" }, "memoryUsage": { "type": "integer", "format": "int32" }, "networkReceiveKBps": { "type": "integer", "format": "int32" }, "networkSentKBps": { "type": "integer", "format": "int32" }, "liveSessionCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DashboardSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "siteID": { "type": "string", "format": "uuid" }, "customerID": { "type": "string", "nullable": true }, "cpuWarningThreshold": { "type": "number", "format": "double" }, "cpuCriticalThreshold": { "type": "number", "format": "double" }, "memoryWarningThreshold": { "type": "number", "format": "double" }, "memoryCriticalThreshold": { "type": "number", "format": "double" }, "networkSendWarningThreshold": { "type": "number", "format": "double" }, "networkSendCriticalThreshold": { "type": "number", "format": "double" }, "networkReceiveWarningThreshold": { "type": "number", "format": "double" }, "networkReceiveCriticalThreshold": { "type": "number", "format": "double" }, "enableSuccessRate": { "type": "boolean" }, "dashboardStorageLocationSettingsList": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardStorageLocationSettings" }, "nullable": true }, "enableStorageConsumptionForecast": { "type": "boolean" }, "createBy": { "type": "string", "nullable": true }, "createTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "updateBy": { "type": "string", "nullable": true }, "updateTimeUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DashboardStorageLocationSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "siteDashboardSettingsID": { "type": "string", "format": "uuid" }, "storageLocation": { "type": "string", "nullable": true }, "warningThreshold": { "type": "number", "format": "double" }, "totalSize": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DeleteEventParam": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "time": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DeliveryGroupStatistics": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "totalAgentCount": { "type": "integer", "format": "int32" }, "activeAgentCount": { "type": "integer", "format": "int32" }, "inactiveAgentCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiagnosticEventData": { "type": "object", "properties": { "m_eventType": { "type": "string", "nullable": true }, "m_machineName": { "type": "string", "nullable": true }, "m_machineType": { "type": "integer", "format": "int32" }, "m_eventTimeUTC": { "type": "integer", "format": "int64" }, "m_eventCount": { "type": "integer", "format": "int32" }, "m_extra": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DiagnosticEventTypeCount": { "type": "object", "properties": { "eventType": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiagnosticEvents": { "type": "object", "properties": { "diagnosticEventList": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticEventData" }, "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiagnosticEventsByTimePara": { "type": "object", "properties": { "startTimeUTC": { "type": "string", "format": "date-time" }, "machineName": { "type": "string", "nullable": true }, "machineType": { "type": "integer", "format": "int32" }, "timeRangeStart": { "type": "string", "format": "date-time" }, "timeRangeEnd": { "type": "string", "format": "date-time" }, "pageSize": { "type": "integer", "format": "int32" }, "offSet": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiagnosticEventsByTypePara": { "type": "object", "properties": { "startTimeUTC": { "type": "string", "format": "date-time" }, "machineName": { "type": "string", "nullable": true }, "machineType": { "type": "integer", "format": "int32" }, "timeRangeStart": { "type": "string", "format": "date-time" }, "timeRangeEnd": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DiagnosticRetentionSetting": { "type": "object", "properties": { "retentionPeriod": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiagnosticTypesPara": { "type": "object", "properties": { "startTimeUTC": { "type": "string", "format": "date-time" }, "machineName": { "type": "string", "nullable": true }, "machineType": { "type": "integer", "format": "int32" }, "timeRangeStart": { "type": "string", "format": "date-time" }, "timeRangeEnd": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DirectoryContext": { "type": "object", "properties": { "identityProvider": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true }, "idpInstanceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailAlertNotificationSetting": { "type": "object", "additionalProperties": false }, "EmailNotificationQuotaUsage": { "type": "object", "properties": { "subscriptionType": { "$ref": "#/components/schemas/EmailNotificationSubscriptionType" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmailNotificationSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "customerID": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "organizationID": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "defaultRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createBy": { "type": "string", "nullable": true }, "createTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "updateBy": { "type": "string", "nullable": true }, "updateTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "resourceUsageAlertsSubscription": { "$ref": "#/components/schemas/ResourceUsageAlertsSubscription" }, "serverStatusChangesSubscription": { "$ref": "#/components/schemas/ServerStatusChangesSubscription" }, "storageMaintenanceResultsSubscription": { "$ref": "#/components/schemas/StorageMaintenanceResultsSubscription" }, "playBackLinkNotificationSubscription": { "$ref": "#/components/schemas/PlayBackLinkNotificationSubscription" }, "successRateNotificationSubscription": { "$ref": "#/components/schemas/SuccessRateNotificationSubscription" } }, "additionalProperties": false }, "EmailNotificationSubscriptionType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "EndPointRulePara": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "record": { "type": "boolean" }, "notify": { "type": "boolean" }, "entireScreen": { "type": "boolean" }, "targetAppList": { "type": "string", "nullable": true }, "ruleName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "usersOrGroups": { "type": "string", "nullable": true }, "userOid": { "type": "string", "nullable": true }, "groupOid": { "type": "string", "nullable": true }, "aadUsersOrGroups": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointGateway": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "publicUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointRecordingRoute": { "type": "object", "properties": { "ver": { "type": "integer", "format": "int32" }, "routeID": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "nullable": true }, "siteID": { "type": "string", "format": "uuid" }, "siteName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointServerConfig": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointSta": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "publicUrl": { "type": "string", "nullable": true }, "staSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointStoreFront": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "storeServiceUrl": { "type": "string", "nullable": true }, "authenticationServiceUrl": { "type": "string", "nullable": true }, "realm": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointsReplyV1": { "type": "object", "properties": { "customerEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEndpoint" }, "nullable": true } }, "additionalProperties": false }, "ErrorModel": { "required": [ "detail", "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string" }, "detail": { "minLength": 1, "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorParameters" }, "nullable": true } }, "additionalProperties": false }, "ErrorParameters": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "value": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "EventAttributes": { "enum": [ 0, 512, 1024 ], "type": "integer", "format": "int32" }, "EventBase": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "time": { "type": "integer", "format": "int64" }, "customer": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "server": { "type": "string", "format": "uuid" }, "site": { "type": "string", "format": "uuid" }, "severity": { "$ref": "#/components/schemas/Severity" }, "lifetime": { "$ref": "#/components/schemas/EventStatus" } }, "additionalProperties": false }, "EventDataExportSetting": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "destination": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EventFileMetadata": { "type": "object", "additionalProperties": false }, "EventInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/EventAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "addMethod": { "$ref": "#/components/schemas/MethodInfo" }, "removeMethod": { "$ref": "#/components/schemas/MethodInfo" }, "raiseMethod": { "$ref": "#/components/schemas/MethodInfo" }, "isMulticast": { "type": "boolean", "readOnly": true }, "eventHandlerType": { "$ref": "#/components/schemas/Type" } }, "additionalProperties": false }, "EventListInfo": { "type": "object", "properties": { "eventCount": { "type": "integer", "format": "int32" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventSimple" }, "nullable": true } }, "additionalProperties": false }, "EventMetadata": { "type": "object", "properties": { "data": { "type": "string", "format": "byte", "nullable": true }, "eventTimeTicks": { "type": "integer", "format": "int64" }, "id": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" }, "searchable": { "type": "boolean" }, "text": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventMetadataList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EventMetadata" }, "nullable": true } }, "additionalProperties": false }, "EventRulePara": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "cdm": { "type": "boolean" }, "generic": { "type": "boolean" }, "appLaunch": { "type": "integer", "format": "int32" }, "sensitiveFile": { "type": "boolean" }, "webAccess": { "type": "boolean" }, "topMost": { "type": "boolean" }, "clipboard": { "type": "boolean" }, "accountChange": { "type": "boolean" }, "appChange": { "type": "boolean" }, "appFault": { "type": "boolean" }, "perfData": { "type": "boolean" }, "rdp": { "type": "boolean" }, "registry": { "type": "boolean" }, "popup": { "type": "boolean" }, "print": { "type": "boolean" }, "printingFile": { "type": "boolean" }, "printingFilesMaxSize": { "type": "integer", "format": "int32" }, "appLaunchText": { "type": "string", "nullable": true }, "sensitiveFileText": { "type": "string", "nullable": true }, "registryText": { "type": "string", "nullable": true }, "ruleName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "clientIPs": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "usersOrGroups": { "type": "string", "nullable": true }, "publishedResources": { "type": "string", "nullable": true }, "deliveryGroupsOrMachines": { "type": "string", "nullable": true }, "cloudDDC": { "type": "boolean" }, "deliveryControllerAddress": { "type": "string", "nullable": true }, "userOid": { "type": "string", "nullable": true }, "groupOid": { "type": "string", "nullable": true }, "aadUsersOrGroups": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventSimple": { "type": "object", "properties": { "user": { "type": "string", "nullable": true }, "client": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true }, "timeUTC": { "type": "string", "format": "date-time" }, "timeLocal": { "type": "string", "format": "date-time" }, "details": { "type": "string", "nullable": true }, "fileId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "EventStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "EventTriggerTemplate": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "templateID": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createUser": { "type": "string", "nullable": true }, "accessTimeUtc": { "type": "integer", "format": "int64" }, "clickTime": { "type": "integer", "format": "int32" }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/AlertTemplate" }, "nullable": true }, "systemDefined": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "version": { "type": "integer", "format": "int32" }, "eventTypeTag": { "type": "string", "nullable": true }, "contexturalTag": { "type": "string", "nullable": true }, "eventTypeTagEx": { "type": "string", "nullable": true }, "contexturalTagEx": { "type": "string", "nullable": true }, "templateTag": { "type": "string", "nullable": true }, "weight": { "type": "integer", "format": "int32" }, "srMinVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventUploadSettings": { "type": "object", "properties": { "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "ExportMachineInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "machineName": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid" }, "taskServiceVersion": { "type": "string", "nullable": true }, "lastActiveUtcTime": { "type": "string", "format": "date-time" }, "status": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ExportRecordingReason": { "type": "object", "additionalProperties": false }, "FieldAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 16, 32, 64, 128, 256, 512, 1024, 4096, 8192, 32768, 38144 ], "type": "integer", "format": "int32" }, "FieldInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/FieldAttributes" }, "fieldType": { "$ref": "#/components/schemas/Type" }, "isInitOnly": { "type": "boolean", "readOnly": true }, "isLiteral": { "type": "boolean", "readOnly": true }, "isNotSerialized": { "type": "boolean", "readOnly": true, "deprecated": true }, "isPinvokeImpl": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "fieldHandle": { "$ref": "#/components/schemas/RuntimeFieldHandle" } }, "additionalProperties": false }, "FileMetadata": { "type": "object", "properties": { "aAName": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archiveNotes": { "type": "string", "nullable": true }, "archiveTimeUtcTicks": { "type": "integer", "format": "int64" }, "clientAddress": { "type": "string", "nullable": true }, "clientEncryption": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "clientProductId": { "type": "integer", "format": "int32" }, "clientProductVersion": { "type": "string", "nullable": true }, "clientResolution": { "$ref": "#/components/schemas/Resolution" }, "ctxSessionId": { "type": "string", "format": "uuid" }, "daylightSavings": { "type": "boolean" }, "deliveryGroup": { "type": "string", "nullable": true }, "dormantTimeInHours": { "type": "integer", "format": "int32" }, "endTimeTicks": { "type": "integer", "format": "int64" }, "endTimeUtcTicks": { "type": "integer", "format": "int64" }, "eventCount": { "type": "integer", "format": "int32" }, "farmName": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64" }, "durationToSecondsEstimated": { "type": "string", "nullable": true }, "id": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" }, "liveOrDormant": { "type": "boolean" }, "loginTimeTicks": { "type": "integer", "format": "int64" }, "loginTimeUtcTicks": { "type": "integer", "format": "int64" }, "nextFileId": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" }, "prevFileId": { "maxLength": 36, "minLength": 36, "pattern": "/^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i", "type": "string", "format": "uuid" }, "serverName": { "type": "string", "nullable": true }, "serverId": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "sessionName": { "type": "string", "nullable": true }, "startTimeTicks": { "type": "integer", "format": "int64" }, "startTimeUtcTicks": { "type": "integer", "format": "int64" }, "userAccountName": { "type": "string", "nullable": true }, "zoneName": { "type": "string", "nullable": true }, "eventOnly": { "type": "boolean" }, "srServerName": { "type": "string", "nullable": true }, "restrictedBy": { "type": "string", "nullable": true }, "restrictedReason": { "type": "string", "nullable": true }, "expireTime": { "type": "string", "nullable": true }, "hmac": { "type": "string", "nullable": true }, "universalPrincipalName": { "type": "string", "nullable": true }, "audioEnabled": { "type": "boolean" }, "lossyVideoCodecEnabled": { "type": "boolean" }, "iclFileProperty": { "type": "integer", "format": "int64" }, "linksCount": { "type": "integer", "format": "int32" }, "recordingType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileMetadataList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileMetadata" }, "nullable": true } }, "additionalProperties": false }, "FileShareDetails": { "type": "object", "properties": { "fileShareCount": { "type": "string", "nullable": true }, "storageSku": { "type": "string", "nullable": true }, "premiumCapacity": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GenericParameterAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 28 ], "type": "integer", "format": "int32" }, "Group": { "type": "object", "properties": { "oid": { "type": "string", "nullable": true }, "sid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupInfo": { "type": "object", "properties": { "groupOid": { "type": "string", "nullable": true }, "groupDisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "Identity": { "type": "object", "properties": { "oid": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "upn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdentityProviderEnabled": { "type": "object", "properties": { "ad": { "type": "boolean" }, "adaptiveauth": { "type": "boolean" }, "azuread": { "type": "boolean" }, "adotp": { "type": "boolean" }, "onpremgateway": { "type": "boolean" }, "okta": { "type": "boolean" }, "google": { "type": "boolean" }, "saml": { "type": "boolean" }, "adradius": { "type": "boolean" } }, "additionalProperties": false }, "Incident": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "fileId": { "type": "string", "format": "uuid" }, "sessionId": { "type": "string", "format": "uuid" }, "category": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "definitionId": { "type": "string", "nullable": true }, "timeUTC": { "type": "string", "format": "date-time" }, "timeLocal": { "type": "string", "format": "date-time" }, "user": { "type": "string", "nullable": true }, "userGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "client": { "type": "string", "nullable": true }, "eventIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "ext": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Incident4Search": { "type": "object", "properties": { "user": { "type": "string", "nullable": true }, "client": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "timeUTC": { "type": "string", "format": "date-time" }, "timeLocal": { "type": "string", "format": "date-time" }, "summary": { "type": "string", "nullable": true }, "fileId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IncidentChartInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "time": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "IncidentDefinitionSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "customerId": { "type": "string", "nullable": true }, "incidentDefinitionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "IncidentLib": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "incidentDefinitionId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true }, "srQL": { "type": "string", "nullable": true }, "condition": { "type": "string", "nullable": true }, "mitreTacticsId": { "type": "string", "nullable": true }, "mitreTacticsName": { "type": "string", "nullable": true }, "mitreTechniqueId": { "type": "string", "nullable": true }, "mitreTechniqueName": { "type": "string", "nullable": true }, "customList": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "IncidentLimit": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "dateRange": { "type": "array", "items": { "type": "string" }, "nullable": true }, "count": { "type": "integer", "format": "int32" }, "startTimeSpan": { "type": "integer", "format": "int32" }, "endTimeSpan": { "type": "integer", "format": "int32" }, "users": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "userGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "keyword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IncidentListInfo": { "type": "object", "properties": { "incidentCount": { "type": "integer", "format": "int32" }, "incidents": { "type": "array", "items": { "$ref": "#/components/schemas/Incident4Search" }, "nullable": true } }, "additionalProperties": false }, "IncidentRankingInfo": { "type": "object", "properties": { "incidentCount": { "type": "integer", "format": "int32" }, "userCount": { "type": "integer", "format": "int32" }, "clientCount": { "type": "integer", "format": "int32" }, "categoryCount": { "type": "integer", "format": "int32" }, "userGroupCount": { "type": "integer", "format": "int32" }, "clientRank": { "type": "array", "items": { "$ref": "#/components/schemas/countInfo" }, "nullable": true }, "userRank": { "type": "array", "items": { "$ref": "#/components/schemas/countInfo" }, "nullable": true }, "categoryRank": { "type": "array", "items": { "$ref": "#/components/schemas/countInfo" }, "nullable": true }, "userGroupRank": { "type": "array", "items": { "$ref": "#/components/schemas/countInfo" }, "nullable": true } }, "additionalProperties": false }, "IncidentReportInfo": { "type": "object", "properties": { "incidentRankingInfo": { "$ref": "#/components/schemas/IncidentRankingInfo" }, "incidentBarGraphInfo": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" }, "nullable": true }, "incidentHeatMapInfo": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentChartInfo" }, "nullable": true } }, "additionalProperties": false }, "IncidentSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "customerId": { "type": "string", "nullable": true }, "siteId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "InstallingProgress": { "type": "object", "properties": { "progress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntPtr": { "type": "object", "additionalProperties": false }, "IntegrationSettings": { "type": "object", "properties": { "splunkIntegrationSettings": { "$ref": "#/components/schemas/SplunkIntegrationSettings" }, "msSentinelIntegrationSettings": { "$ref": "#/components/schemas/MSSentinelIntegrationSettings" }, "eventDataExportSettings": { "type": "array", "items": { "$ref": "#/components/schemas/EventDataExportSetting" }, "nullable": true } }, "additionalProperties": false }, "LayoutKind": { "enum": [ 0, 2, 3 ], "type": "integer", "format": "int32" }, "LoadBalancerDetails": { "type": "object", "properties": { "allowedSourceIPs": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "customDomain": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogRedirectionConfig": { "type": "object", "properties": { "iis": { "type": "boolean" }, "storageManager": { "type": "boolean" }, "cloudClient": { "type": "boolean" }, "broker": { "type": "boolean" }, "analyticsService": { "type": "boolean" }, "monitorService": { "type": "boolean" } }, "additionalProperties": false }, "MSSentinelIntegrationSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "customerID": { "type": "string", "nullable": true }, "workspaceID": { "type": "string", "format": "uuid" }, "encryptedKey": { "type": "string", "nullable": true }, "keyVersion": { "type": "string", "nullable": true }, "tableName": { "type": "string", "nullable": true }, "createBy": { "type": "string", "nullable": true }, "createTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "updateBy": { "type": "string", "nullable": true }, "updateTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 191 ], "type": "integer", "format": "int32" }, "MethodAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248 ], "type": "integer", "format": "int32" }, "MethodBase": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MethodImplAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 32, 64, 128, 256, 512, 4096, 65535 ], "type": "integer", "format": "int32" }, "MethodInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "$ref": "#/components/schemas/Type" }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MyCDFTraceRecord": { "type": "object", "properties": { "traceNumber": { "type": "string", "nullable": true }, "cpu": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "threadId": { "type": "string", "nullable": true }, "processId": { "type": "string", "nullable": true }, "sessionId": { "type": "string", "nullable": true }, "moduleName": { "type": "string", "nullable": true }, "file": { "type": "string", "nullable": true }, "line": { "type": "string", "nullable": true }, "function": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true }, "class": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NormalSearchQueryParametersWithAbsoluteTimeAndSwagger": { "type": "object", "properties": { "aAName": { "type": "string", "nullable": true }, "activeTime": { "$ref": "#/components/schemas/AbsoluteTimeQueryCondition" }, "applicationName": { "type": "string", "nullable": true }, "clientAddress": { "pattern": "^[a-fA-F0-9\\.\\:]+$|^localhost$", "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "deliveryGroupName": { "type": "string", "nullable": true }, "durationMax": { "type": "integer", "format": "int32" }, "durationMin": { "type": "integer", "format": "int32" }, "eventText": { "type": "string", "nullable": true }, "eventTypeName": { "type": "string", "nullable": true }, "fileID": { "type": "string", "format": "uuid" }, "groupAccountName": { "type": "string", "nullable": true }, "serverFarmName": { "type": "string", "nullable": true }, "serverName": { "type": "string", "nullable": true }, "serverZoneName": { "type": "string", "nullable": true }, "sessionName": { "type": "string", "nullable": true }, "userAccountName": { "type": "string", "nullable": true }, "tagged": { "type": "integer", "format": "int32" }, "maxResults": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OnPremPlaybackSource": { "type": "object", "properties": { "onPremPlayerEnabled": { "type": "boolean" } }, "additionalProperties": false }, "OnPremSQLCpuLog": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "siteId": { "type": "string", "nullable": true }, "serverId": { "type": "string", "nullable": true }, "used": { "type": "integer", "format": "int32" }, "idle": { "type": "integer", "format": "int32" }, "timeUtc": { "type": "string", "format": "date-time" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OnPremSQLLogRecord": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "siteId": { "type": "string", "nullable": true }, "serverId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "startTimeUtc": { "type": "string", "format": "date-time" }, "endTimeUtc": { "type": "string", "format": "date-time" }, "totalSeconds": { "type": "number", "format": "double" }, "comment": { "type": "string", "nullable": true }, "saveDB": { "type": "boolean" } }, "additionalProperties": false }, "ParameterAttributes": { "enum": [ 0, 1, 2, 4, 8, 16, 4096, 8192, 16384, 32768, 61440 ], "type": "integer", "format": "int32" }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "$ref": "#/components/schemas/Type" }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "PerformanceRecord": { "type": "object", "properties": { "timeTicksUTC": { "type": "integer", "format": "int64" }, "data": { "$ref": "#/components/schemas/DashboardServerPerformanceData" } }, "additionalProperties": false }, "PlayBackLinkNotificationSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "useDefaultRecipients": { "type": "boolean" }, "customRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PlayLink": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "expiredTime": { "type": "string", "nullable": true }, "seekTime": { "type": "string", "nullable": true }, "encryptedTime": { "type": "string", "nullable": true }, "playLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlaybackActivity": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "topViewers": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackViewer" }, "nullable": true }, "playbackHistory": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackInfoRecord" }, "nullable": true } }, "additionalProperties": false }, "PlaybackConfig": { "type": "object", "properties": { "playbackReasonLoggingEnabled": { "type": "boolean" }, "siteId": { "type": "string", "format": "uuid" }, "serverId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PlaybackHistoryDashboardStatistics": { "type": "object", "properties": { "mostPlayedRecordings": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackRecordStatistics" }, "nullable": true }, "topViewers": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackUserStatistics" }, "nullable": true }, "filterByFileId": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackUserStatistics" }, "nullable": true }, "nullable": true }, "filterByUserName": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PlaybackRecordStatistics" }, "nullable": true }, "nullable": true }, "recordingMetadataList": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "PlaybackInfoRecord": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "timeUTC": { "type": "string", "format": "date-time" }, "playbackJustification": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlaybackReason": { "type": "object", "additionalProperties": false }, "PlaybackRecordStatistics": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "playbackCount": { "type": "integer", "format": "int32" }, "application": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "startTimeUtcTicks": { "type": "integer", "format": "int64" }, "duration": { "type": "string", "format": "date-span" }, "vda": { "type": "string", "nullable": true }, "client": { "type": "string", "nullable": true }, "eventCount": { "type": "integer", "format": "int32" }, "serverId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PlaybackUserStatistics": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlaybackViewer": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlayerUserAccountRolePolicyInfo2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountType": { "$ref": "#/components/schemas/PlayerUserAccountRoleType" }, "userInfo": { "type": "string", "nullable": true }, "domainGroupInfo": { "type": "string", "nullable": true }, "principalName": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "ucOid": { "type": "string", "nullable": true }, "groupInfo": { "$ref": "#/components/schemas/PlayerUserPolicyGroupInfo" }, "configInfo": { "$ref": "#/components/schemas/PlayerUserPolicyConfigInfo" }, "enabled": { "type": "boolean" }, "createTimeTicks": { "type": "integer", "format": "int64" }, "modifiedTimeTicks": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PlayerUserAccountRoleType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PlayerUserPolicyConfigInfo": { "type": "object", "properties": { "userInfos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "groupInfos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "azureUserInfos": { "type": "array", "items": { "$ref": "#/components/schemas/AzureUserObject" }, "nullable": true }, "azureGroupInfos": { "type": "array", "items": { "$ref": "#/components/schemas/AzureGroupObject" }, "nullable": true }, "serversInfos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "appsInfos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deliveryGroupInfos": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PlayerUserPolicyGroupInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyDocInfo": { "type": "object", "properties": { "m_PolicyDocumentInfo": { "$ref": "#/components/schemas/PolicyDocumentInfo" }, "m_PolicyFile": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyDocumentInfo": { "type": "object", "additionalProperties": false }, "PolicyDocumentList": { "type": "object", "properties": { "items": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "PolicyDocumentParas": { "type": "object", "properties": { "policyType": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyRuleType": { "enum": [ 1, 3, 4, 6, 7 ], "type": "integer", "format": "int32" }, "PostCommentBodyJSON": { "type": "object", "additionalProperties": false }, "PremierSiteInfo": { "type": "object", "properties": { "siteName": { "type": "string", "nullable": true }, "siteDescription": { "type": "string", "nullable": true }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" }, "nullable": true }, "siteId": { "type": "string", "format": "uuid" }, "siteHashCode": { "type": "string", "nullable": true }, "turnKey": { "type": "boolean" }, "turnKeyMode": { "$ref": "#/components/schemas/TurnKeyDeploymentMode" }, "turnKeyStatus": { "$ref": "#/components/schemas/TurnKeyDeploymentStatus" }, "storageLocations": { "type": "array", "items": { "$ref": "#/components/schemas/AzureStorageLocation" }, "nullable": true }, "databases": { "type": "array", "items": { "$ref": "#/components/schemas/AzureDatabase" }, "nullable": true }, "loadBalancer": { "$ref": "#/components/schemas/AzureLoadBalancer" }, "resourceGroup": { "type": "string", "nullable": true }, "connectionId": { "type": "string", "format": "uuid" }, "connectionName": { "type": "string", "nullable": true }, "currentMonthCost": { "type": "string", "nullable": true }, "srAgents": { "type": "array", "items": { "$ref": "#/components/schemas/SrAgent" }, "nullable": true }, "srExportMachineInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMachineInfo" }, "nullable": true } }, "additionalProperties": false }, "PropertiesEx": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "businessPhones": { "type": "array", "items": { "type": "string" }, "nullable": true }, "mail": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "userPrincipalName": { "type": "string", "nullable": true }, "accountEnabled": { "type": "boolean" } }, "additionalProperties": false }, "PropertyAttributes": { "enum": [ 0, 512, 1024, 4096, 8192, 16384, 32768, 62464 ], "type": "integer", "format": "int32" }, "PropertyInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "$ref": "#/components/schemas/Type" }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "PublishedEventTriggerTemplate": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publisherDisplayName": { "type": "string", "nullable": true }, "anonymous": { "type": "boolean" }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/AlertTemplate" }, "nullable": true }, "eventTypeTag": { "type": "string", "nullable": true }, "contexturalTag": { "type": "string", "nullable": true }, "likesTimes": { "type": "integer", "format": "int32" }, "usedTimes": { "type": "integer", "format": "int32" }, "publishedTimeUtc": { "type": "string", "format": "date-time" }, "publishOrg": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "publishedTimeUtcTicks": { "type": "integer", "format": "int64" }, "reviewTimeUtc": { "type": "string", "format": "date-time" }, "reviewTimeUtcTicks": { "type": "integer", "format": "int64" }, "message": { "type": "string", "nullable": true }, "srMinVersion": { "type": "string", "nullable": true }, "likeId": { "type": "string", "nullable": true }, "bookmarkId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublishedTemplateStatus": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "srMinVersion": { "type": "string", "nullable": true }, "statusOnly": { "type": "boolean" }, "sendEmail": { "type": "boolean" } }, "additionalProperties": false }, "QueueSasResponse": { "type": "object", "properties": { "endpoint": { "type": "string", "nullable": true }, "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/QueueSasToken" }, "nullable": true } }, "additionalProperties": false }, "QueueSasToken": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordRulePara": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "record": { "type": "boolean" }, "notify": { "type": "boolean" }, "eventOnly": { "type": "boolean" }, "enableAudio": { "type": "boolean" }, "enableLossyVideoCodec": { "type": "boolean" }, "enableHideWindow": { "type": "boolean" }, "hideWindowList": { "type": "string", "nullable": true }, "hideWindowARGB": { "type": "integer", "format": "int32" }, "ruleName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "clientIPs": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "usersOrGroups": { "type": "string", "nullable": true }, "publishedResources": { "type": "string", "nullable": true }, "deliveryGroupsOrMachines": { "type": "string", "nullable": true }, "cloudDDC": { "type": "boolean" }, "deliveryControllerAddress": { "type": "string", "nullable": true }, "userOid": { "type": "string", "nullable": true }, "groupOid": { "type": "string", "nullable": true }, "aadUsersOrGroups": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordSuccessRate": { "type": "object", "properties": { "customerID": { "type": "string", "nullable": true }, "taskID": { "type": "string", "format": "uuid" }, "actualRecordCount": { "type": "integer", "format": "int32" }, "needRecordCount": { "type": "integer", "format": "int32" }, "createTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "RecordingFile": { "type": "object", "additionalProperties": false }, "RegistryKeyRequest": { "type": "object", "properties": { "registryKey": { "type": "string", "nullable": true }, "valueName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistryObject": { "type": "object", "properties": { "registryKey": { "type": "string", "nullable": true }, "valueName": { "type": "string", "nullable": true }, "registryValue": { "type": "string", "nullable": true }, "registryValueKind": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportSetting": { "type": "object", "properties": { "enableReport": { "type": "integer", "format": "int32" }, "reportInterval": { "type": "integer", "format": "int32" }, "weekdayOrDate": { "type": "integer", "format": "int32" }, "emailRecipients": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestStatisticParam": { "type": "object", "properties": { "startHourUtc": { "type": "integer", "format": "int64" }, "endHourUtc": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Resolution": { "type": "object", "properties": { "depth": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceResponseModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResourceUsageAlertsSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "useDefaultRecipients": { "type": "boolean" }, "customRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resourceUsages": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceUsageType" }, "nullable": true }, "severities": { "type": "array", "items": { "$ref": "#/components/schemas/Severity" }, "nullable": true } }, "additionalProperties": false }, "ResourceUsageType": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "RestrictedParam": { "type": "object", "properties": { "fileIdList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RuleBase": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PolicyRuleType" }, "schedule": { "type": "string", "nullable": true }, "actionOnSuccess": { "$ref": "#/components/schemas/Action" }, "actionOnFailure": { "$ref": "#/components/schemas/Action" } }, "additionalProperties": false }, "RuntimeFieldHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeTypeHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "SRTask": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "iclFileId": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "serverId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/SRTaskType" }, "createTime": { "type": "string", "format": "date-time" }, "createTimeUtc": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "startTimeUtc": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "endTimeUtc": { "type": "string", "format": "date-time" }, "userAccountName": { "type": "string", "nullable": true }, "deliveryGroup": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SRTaskStatus" }, "machineName": { "type": "string", "nullable": true }, "filePath": { "type": "string", "nullable": true }, "sha256": { "type": "string", "nullable": true }, "parameters": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SRTaskStatus": { "enum": [ 0, 1, 2, 3, -1 ], "type": "integer", "format": "int32" }, "SRTaskType": { "enum": [ 0, 1, 2, 3, 4, -1 ], "type": "integer", "format": "int32" }, "SaveResult": { "type": "object", "properties": { "newModifiedTimeUtcTicks": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SaveSrServerVersionInfoRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "beta": { "type": "boolean" }, "enableDisplay": { "type": "boolean" }, "supportTurnKey": { "type": "boolean" } }, "additionalProperties": false }, "SecurityRuleSet": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Server": { "type": "object", "properties": { "serverName": { "type": "string", "nullable": true }, "serverId": { "type": "string", "format": "uuid" }, "serverDescription": { "type": "string", "nullable": true }, "serverStatusType": { "$ref": "#/components/schemas/ServerStatusType" }, "serverStatusTypeA": { "$ref": "#/components/schemas/ServerStatusType" }, "serverStatusTypeB": { "$ref": "#/components/schemas/ServerStatusType" }, "serverClientVersion": { "type": "string", "nullable": true }, "serverSoftwareVersion": { "type": "string", "nullable": true }, "serverGeoLocation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServerConfigParas": { "type": "object", "properties": { "fileStorageDirectories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fullRestorePath": { "type": "string", "nullable": true }, "signingCertificateThumbprint": { "type": "string", "nullable": true }, "rolloverFileSizeInMB": { "type": "integer", "format": "int32" }, "rolloverTimeInHours": { "type": "integer", "format": "int32" }, "playbackProtectionEnabled": { "type": "boolean" }, "allowLivePlayback": { "type": "boolean" }, "notifyMessageDefault": { "type": "string", "nullable": true }, "notifyTitleDefault": { "type": "string", "nullable": true }, "notifyMessageByCulture": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notifyTitleByCulture": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allowUserSelect": { "type": "boolean" }, "analyticsEnabled": { "type": "boolean" }, "loggingLoggingState": { "type": "integer", "format": "int32" }, "loggingBlockState": { "type": "integer", "format": "int32" }, "playbackLoggingReasonState": { "type": "integer", "format": "int32" }, "enableRBACState": { "type": "integer", "format": "int32" }, "enableSendEmail": { "type": "integer", "format": "int32" }, "strEmailTitle": { "type": "string", "nullable": true }, "strEmailBody": { "type": "string", "nullable": true }, "strEmailHost": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "enabledSSL": { "type": "integer", "format": "int32" }, "strEmailSender": { "type": "string", "nullable": true }, "strEmailSenderUserName": { "type": "string", "nullable": true }, "strEmailSenderPassword": { "type": "string", "nullable": true }, "instanceName": { "type": "string", "nullable": true }, "databaseName": { "type": "string", "nullable": true }, "loggingDatabaseName": { "type": "string", "nullable": true }, "enableCloudDatabase": { "type": "boolean" }, "cloudSqlUsername": { "type": "string", "nullable": true }, "cloudSqlPassword": { "type": "string", "nullable": true }, "skipWorkspaceCheck": { "type": "boolean" }, "hideWebplayerHomepage": { "type": "boolean" }, "reportSetting": { "$ref": "#/components/schemas/ReportSetting" } }, "additionalProperties": false }, "ServerDetails": { "type": "object", "properties": { "serverCount": { "type": "string", "nullable": true }, "serverVersion": { "type": "string", "nullable": true }, "serverVersionId": { "type": "integer", "format": "int32" }, "image": { "type": "string", "nullable": true }, "domainEnableJoin": { "type": "boolean" }, "domainName": { "type": "string", "nullable": true }, "domainAddress": { "type": "string", "nullable": true }, "vmAdminUsername": { "type": "string", "nullable": true }, "sqlAdminUsername": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServerInfo": { "type": "object", "properties": { "siteName": { "type": "string", "nullable": true }, "serverName": { "type": "string", "nullable": true }, "serverStatusType": { "$ref": "#/components/schemas/ServerStatusType" }, "serverStatusTypeA": { "$ref": "#/components/schemas/ServerStatusType" }, "serverStatusTypeB": { "$ref": "#/components/schemas/ServerStatusType" }, "serverDescription": { "type": "string", "nullable": true }, "statusTime": { "type": "string", "format": "date-time" }, "serverId": { "type": "string", "format": "uuid" }, "siteHashCode": { "type": "string", "nullable": true }, "serverClientVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServerStatusChangesSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "useDefaultRecipients": { "type": "boolean" }, "customRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serverStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ServerStatusType" }, "nullable": true } }, "additionalProperties": false }, "ServerStatusType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32" }, "ServiceMetrics": { "type": "object", "properties": { "iis": { "$ref": "#/components/schemas/CPUMemUsage" }, "storeageManager": { "$ref": "#/components/schemas/CPUMemUsage" }, "analyticsService": { "$ref": "#/components/schemas/CPUMemUsage" }, "cloudClient": { "$ref": "#/components/schemas/CPUMemUsage" }, "cloudClientMonitor": { "$ref": "#/components/schemas/CPUMemUsage" } }, "additionalProperties": false }, "ServiceNameRequest": { "type": "object", "properties": { "serviceName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceState": { "type": "object", "properties": { "endpointRecordingEnabled": { "type": "boolean" } }, "additionalProperties": false }, "SessionByDurationOrSize": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int32" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/SessionPerCategory" }, "nullable": true } }, "additionalProperties": false }, "SessionDashboard": { "type": "object", "properties": { "totalSessions": { "type": "integer", "format": "int32" }, "averageSession": { "type": "string", "format": "date-span" }, "longestSession": { "type": "string", "format": "date-span" }, "longestId": { "type": "string", "format": "uuid" }, "averageFile": { "type": "number", "format": "double" }, "largestFile": { "type": "number", "format": "double" }, "largestId": { "type": "string", "format": "uuid" }, "left2Data": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/SessionByDurationOrSize" } }, "nullable": true }, "right2Data": { "type": "array", "items": { "$ref": "#/components/schemas/VDAPerDay" }, "nullable": true } }, "additionalProperties": false }, "SessionDetail": { "type": "object", "properties": { "startTimeUTCTicks": { "type": "integer", "format": "int64" }, "endTimeUTCTicks": { "type": "integer", "format": "int64" }, "durationInSeconds": { "type": "string", "format": "date-span" }, "sessionSizeInByte": { "type": "integer", "format": "int64" }, "serverId": { "type": "string", "format": "uuid" }, "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/SessionFileMetadata" }, "nullable": true } }, "additionalProperties": false }, "SessionFileMetadata": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nextFileId": { "type": "string", "format": "uuid" }, "prevFileId": { "type": "string", "format": "uuid" }, "startTimeUtcTicks": { "type": "integer", "format": "int64" }, "fileSize": { "type": "integer", "format": "int64" }, "userAccountName": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "vdaName": { "type": "string", "nullable": true }, "eventCount": { "type": "integer", "format": "int32" }, "eventOnly": { "type": "boolean" }, "durationToSecondsEstimated": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "SessionKeys": { "type": "object", "properties": { "ctxSessionIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SessionPerCategory": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "num": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SessionUploadData": { "type": "object", "properties": { "hourTicksUTC": { "type": "integer", "format": "int64" }, "hourSessionCount": { "type": "integer", "format": "int32" }, "hourVdaCount": { "type": "integer", "format": "int32" }, "lessThan100MB": { "type": "integer", "format": "int32" }, "lessThan500MB": { "type": "integer", "format": "int32" }, "lessThan1GB": { "type": "integer", "format": "int32" }, "moreThan1GB": { "type": "integer", "format": "int32" }, "lessThan1h": { "type": "integer", "format": "int32" }, "lessThan4h": { "type": "integer", "format": "int32" }, "lessThan8h": { "type": "integer", "format": "int32" }, "moreThan8h": { "type": "integer", "format": "int32" }, "longestSessionLastFileId": { "type": "string", "format": "uuid" }, "longestSessionDuration": { "type": "integer", "format": "int32" }, "largestSessionLastFileId": { "type": "string", "format": "uuid" }, "largestSessionSize": { "type": "integer", "format": "int64" }, "averageSessionDuration": { "type": "integer", "format": "int32" }, "averageSessionSize": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Severity": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "SingleGroupInfo": { "type": "object", "properties": { "oid": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SiteInfo": { "type": "object", "properties": { "siteName": { "type": "string", "nullable": true }, "siteDescription": { "type": "string", "nullable": true }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" }, "nullable": true }, "siteId": { "type": "string", "format": "uuid" }, "siteHashCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SitePolicy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdTimeUtcTicks": { "type": "integer", "format": "int64" }, "modifiedTimeUtcTicks": { "type": "integer", "format": "int64" }, "createdUser": { "type": "string", "nullable": true }, "modifiedUser": { "type": "string", "nullable": true }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/RuleBase" }, "nullable": true }, "siteID": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SizePerDay": { "type": "object", "properties": { "size": { "type": "number", "format": "double" }, "date": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SizePerLocation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "size": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SplunkIntegrationSettings": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "customerID": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true }, "encryptedToken": { "type": "string", "nullable": true }, "keyVersion": { "type": "string", "nullable": true }, "indexName": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "sourceType": { "type": "string", "nullable": true }, "createBy": { "type": "string", "nullable": true }, "createTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "updateBy": { "type": "string", "nullable": true }, "updateTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "SrAgent": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "vdaVersion": { "type": "string", "nullable": true }, "powerState": { "type": "string", "nullable": true }, "registrationState": { "type": "string", "nullable": true }, "srAgentStatus": { "$ref": "#/components/schemas/SrAgentStatusType" }, "srAgentVersion": { "type": "string", "nullable": true }, "liveRecordingCount": { "type": "integer", "format": "int32" }, "deliveryGroup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SrAgentStatusType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "StatisticInfo": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "rankingInfo": { "type": "array", "items": { "$ref": "#/components/schemas/countInfo" }, "nullable": true } }, "additionalProperties": false }, "StorageDashboard": { "type": "object", "properties": { "storageLocations": { "type": "integer", "format": "int32" }, "totalSizeOfAllRecordings": { "type": "number", "format": "double" }, "totalSizeOfAllRecordingsChange": { "type": "number", "format": "double" }, "daysTotal": { "type": "number", "format": "double" }, "daysTotalChange": { "type": "number", "format": "double" }, "daysAverage": { "type": "number", "format": "double" }, "weekdayAverage": { "type": "number", "format": "double" }, "left1Data": { "type": "array", "items": { "$ref": "#/components/schemas/StorageLocation" }, "nullable": true }, "right1Data": { "type": "array", "items": { "$ref": "#/components/schemas/StoragePerDay" }, "nullable": true } }, "additionalProperties": false }, "StorageLocation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "total": { "type": "number", "format": "double" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SizePerDay" }, "nullable": true }, "forecastData": { "type": "array", "items": { "$ref": "#/components/schemas/SizePerDay" }, "nullable": true }, "warningPercent": { "type": "integer", "format": "int32" }, "warningSize": { "type": "integer", "format": "int32" }, "warning": { "type": "boolean" } }, "additionalProperties": false }, "StorageMaintenanceResultsSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "useDefaultRecipients": { "type": "boolean" }, "customRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StoragePerDay": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "total": { "type": "number", "format": "double" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/SizePerLocation" }, "nullable": true } }, "additionalProperties": false }, "StorageUploadData": { "type": "object", "properties": { "storageLocation": { "type": "string", "nullable": true }, "hourTicksUTC": { "type": "integer", "format": "int64" }, "sizeInByte": { "type": "integer", "format": "int64" }, "totalSize": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "StringCommonResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringStringTuple": { "type": "object", "properties": { "item1": { "type": "string", "nullable": true }, "item2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StructLayoutAttribute": { "type": "object", "properties": { "typeId": { "nullable": true, "readOnly": true }, "value": { "$ref": "#/components/schemas/LayoutKind" } }, "additionalProperties": false }, "SuccessRateNotificationSubscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "useDefaultRecipients": { "type": "boolean" }, "customRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SyncGroupDisplayNameBodyPerSite": { "type": "object", "properties": { "group": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "nullable": true }, "groupOidsQueryFail": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TaskAssignInfo": { "type": "object", "properties": { "serverID": { "type": "string", "format": "uuid" }, "siteID": { "type": "string", "format": "uuid" }, "customerID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskRequestModel": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "nullable": true }, "taskType": { "type": "integer", "format": "int32", "nullable": true }, "taskStatus": { "type": "integer", "format": "int32", "nullable": true }, "startTimeUTC": { "type": "string", "format": "date-time" }, "endTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TaskSearchParam": { "type": "object", "properties": { "startTimeUTC": { "type": "string", "format": "date-time" }, "endTimeUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TaskType": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "TaskUpdateParam": { "type": "object", "properties": { "taskStatus": { "$ref": "#/components/schemas/AsyncTaskStatus" }, "assignTo": { "$ref": "#/components/schemas/TaskAssignInfo" }, "logs": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateID": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string" }, "nullable": true }, "customTemplateIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurnKeyConnection": { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "activeDirectoryId": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "objectId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "clientSecret": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/components/schemas/TurnKeyConnectionType" }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurnKeyConnectionType": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "TurnKeyDeploymentMode": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "TurnKeyDeploymentStatus": { "enum": [ 0, 1, 2, 3, 4, 10, 11, 12, 14, 15, 16, 20, 21, 25, 26, 29, 30, 31 ], "type": "integer", "format": "int32" }, "TurnKeyDetails": { "type": "object", "properties": { "deploymentId": { "type": "string", "format": "uuid" }, "siteId": { "type": "string", "format": "uuid" }, "connectionId": { "type": "string", "format": "uuid" }, "location": { "type": "string", "nullable": true }, "serverDetails": { "$ref": "#/components/schemas/ServerDetails" }, "fileShareDetails": { "$ref": "#/components/schemas/FileShareDetails" }, "loadBalancerDetails": { "$ref": "#/components/schemas/LoadBalancerDetails" } }, "additionalProperties": false }, "Type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TypeAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32, 128, 256, 1024, 2048, 4096, 8192, 16384, 65536, 131072, 196608, 262144, 264192, 1048576, 12582912 ], "type": "integer", "format": "int32" }, "TypeInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true }, "genericTypeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "declaredConstructors": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructorInfo" }, "nullable": true, "readOnly": true }, "declaredEvents": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "nullable": true, "readOnly": true }, "declaredFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true, "readOnly": true }, "declaredMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" }, "nullable": true, "readOnly": true }, "declaredMethods": { "type": "array", "items": { "$ref": "#/components/schemas/MethodInfo" }, "nullable": true, "readOnly": true }, "declaredNestedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "declaredProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyInfo" }, "nullable": true, "readOnly": true }, "implementedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserIdentity": { "type": "object", "properties": { "oid": { "type": "string", "nullable": true }, "upn": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "userPrincipalName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VDAPerDay": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "num": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WebPlayerInstalled": { "type": "object", "properties": { "isInstalled": { "type": "boolean" }, "baseUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "archiveParam": { "type": "object", "properties": { "retentionDays": { "type": "integer", "format": "int32" }, "archiveList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "moveTo": { "type": "string", "nullable": true }, "skipLiveCheck": { "type": "boolean" } }, "additionalProperties": false }, "countInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "countNum": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "dayOfWeek": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128 ], "type": "integer", "description": "description: 0: none, 1: monday, 2: tuesday, 4: wednesday, 8: thursday ,16: friday ,32: saturday ,64: sunday ,128: all", "format": "int32" }, "deleteParam": { "type": "object", "properties": { "retentionDays": { "type": "integer", "format": "int32" }, "deleteList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deleteFiles": { "type": "boolean" }, "skipLiveCheck": { "type": "boolean" } }, "additionalProperties": false }, "postTaskBodyJSON": { "type": "object", "additionalProperties": false }, "serverPropGetConfig": { "type": "object", "properties": { "allowLivePlayback": { "type": "boolean" }, "analyticsEnabled": { "type": "boolean" }, "enableRBACState": { "type": "integer", "format": "int32" }, "fileStorageDirectories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fullRestorePath": { "type": "string", "nullable": true }, "loggingBlockState": { "type": "integer", "format": "int32" }, "loggingLoggingState": { "type": "integer", "format": "int32" }, "notifyMessageByCulture": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notifyTitleByCulture": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rolloverFileSizeInMB": { "type": "integer", "format": "int32" }, "rolloverTimeInHours": { "type": "integer", "format": "int32" }, "signingCertificateThumbprint": { "type": "string", "nullable": true }, "notifyMessageDefault": { "type": "string", "nullable": true }, "notifyTitleDefault": { "type": "string", "nullable": true }, "serverCertificates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allowUserSelect": { "type": "boolean" }, "playbackProtectionEnabled": { "type": "boolean" }, "skipWorkspaceCheck": { "type": "boolean" }, "hideWebplayerHomepage": { "type": "boolean" }, "enableCloudDatabase": { "type": "boolean" }, "cloudSqlUsername": { "type": "string", "nullable": true }, "cloudSqlPassword": { "type": "string", "nullable": true }, "enabledSSL": { "type": "integer", "format": "int32" }, "enableSendEmail": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "strEmailBody": { "type": "string", "nullable": true }, "strEmailHost": { "type": "string", "nullable": true }, "strEmailSender": { "type": "string", "nullable": true }, "strEmailSenderPassword": { "type": "string", "nullable": true }, "strEmailSenderUserName": { "type": "string", "nullable": true }, "strEmailTitle": { "type": "string", "nullable": true }, "reportSetting": { "$ref": "#/components/schemas/ReportSetting" }, "playbackLoggingReasonState": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string", "nullable": true }, "databaseName": { "type": "string", "nullable": true }, "loggingDatabaseName": { "type": "string", "nullable": true }, "serverId": { "type": "string", "format": "uuid" }, "srTaskEnabled": { "type": "boolean" } }, "additionalProperties": false }, "taskResult": { "type": "object", "properties": { "result": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "CwsAuth": { "type": "apiKey", "description": "Citrix Cloud Authorization token", "name": "Authorization", "in": "header" } } }, "security": [ { "CwsAuth": [ ] } ] }