Orchestrator 9 Swagger Differences
729 lines
{
{
"openapi" : "3.0.1",
"openapi" : "3.0.1",
"info" : {
"info" : {
"title" : "VMware Cloud Foundation Operations Orchestrator API",
"title" : "VMware Aria Automation Orchestrator API",
"description" : "<h1>REST Resources</h1>\n\n<p>This API supports a <a href=\"http://en.wikipedia.org/wiki/Representational_State_Transfer\">\nRepresentational State Transfer (REST)</a> model for accessing a set of resources through a fixed set of operations.</p>\n\n<h2>Authorizing requests</h2>\nEvery request made using the VCF Operations Orchestrator REST API must be authorized by an authenticated user.\n\n<p>Depending on whether you configure VCF Operations Orchestrator with vCenter Single Sign-On or oauth2.0, the authentication scheme for the VCF Operations Orchestrator REST API is different.</p>\n\n<h3>Single Sign-On Authentication</h3>\n\n<p>If VCF Operations Orchestrator is configured with the vCenter Single Sign-On (SSO) server, you need a principal\nholder-of-key (HoK) token to access system objects in VCF Operations Orchestrator through the REST API.</p>\n\n<pre>The HoK token is passed as a request <strong>Authorization</strong> header element. The value must be gzip, base64<br />encoded string.</pre>\n\n<h3>Oauth2.0 Authentication</h3>\n\n<p>If VCF Operations Orchestrator is configured with VIDM you need an oauth bearer access token to access system objects in VCF Operations Orchestrator through the REST API.</p>\n\n<pre>The oauth bearer token is passed as request <strong>Authorization</strong> header element. The value must be <strong>Bearer {token}</strong>.</pre>\n\n<h1>Data Model</h1>\n\n<p>\nAll endpoints act on a common set of data. The data can be represented with difference media (i.e. \\\"MIME\\\") types,\ndepending on the endpoint that consumes and/or produces the data. The data can be described by an\n<a href=\"http://www.w3.org/XML/Schema\">XML Schema</a>, which definitively describes the XML representation of\nthe data, but is also useful for describing the other formats of the data, such as <a href=\"http://json.org\">JSON</a>.\n</p>\n\n<p>\nThis document describes the data using terms based on <a href=\"o11n-sdk-rest.xsd\">this schema</a>.\nData can be grouped by namespace, with a schema document describing the <i>elements</i> and <i>types</i> of the\nnamespace. In general, <i>types</i> define the structure of the data and <i>elements</i> are <i>instances</i> of a\ntype. For example, <i>elements</i> are usually produced by (or consumed by) a REST endpoint,\nand the structure of each element is described by its <i>type</i>.\n</p>\n\n<pre>\nTo be able to test the service bellow you need to enable basic authentication over sso.\nThis happens by adding the following property to vmo.properties configuration file:<br />\n<pre>com.vmware.o11n.sso.basic-authentication.enabled = true</pre>\n</pre>\n",
"description" : "<h1>REST Resources</h1>\n\n<p>This API supports a <a href=\"http://en.wikipedia.org/wiki/Representational_State_Transfer\">\nRepresentational State Transfer (REST)</a> model for accessing a set of resources through a fixed set of operations.</p>\n\n<h2>Authorizing requests</h2>\nEvery request made using the Automation Orchestrator REST API must be authorized by an authenticated user.\n\n<p>Depending on whether you configure Automation Orchestrator with vCenter Single Sign-On or oauth2.0, the authentication scheme for the Automation Orchestrator REST API is different.</p>\n\n<h3>Single Sign-On Authentication</h3>\n\n<p>If Automation Orchestrator is configured with the vCenter Single Sign-On (SSO) server, you need a principal\nholder-of-key (HoK) token to access system objects in Automation Orchestrator through the REST API.</p>\n\n<pre>The HoK token is passed as a request <strong>Authorization</strong> header element. The value must be gzip, base64<br />encoded string.</pre>\n\n<h3>Oauth2.0 Authentication</h3>\n\n<p>If Automation Orchestrator is configured with VIDM you need an oauth bearer access token to access system objects in Automation Orchestrator through the REST API.</p>\n\n<pre>The oauth bearer token is passed as request <strong>Authorization</strong> header element. The value must be <strong>Bearer {token}</strong>.</pre>\n\n<h1>Data Model</h1>\n\n<p>\nAll endpoints act on a common set of data. The data can be represented with difference media (i.e. \\\"MIME\\\") types,\ndepending on the endpoint that consumes and/or produces the data. The data can be described by an\n<a href=\"http://www.w3.org/XML/Schema\">XML Schema</a>, which definitively describes the XML representation of\nthe data, but is also useful for describing the other formats of the data, such as <a href=\"http://json.org\">JSON</a>.\n</p>\n\n<p>\nThis document describes the data using terms based on <a href=\"o11n-sdk-rest.xsd\">this schema</a>.\nData can be grouped by namespace, with a schema document describing the <i>elements</i> and <i>types</i> of the\nnamespace. In general, <i>types</i> define the structure of the data and <i>elements</i> are <i>instances</i> of a\ntype. For example, <i>elements</i> are usually produced by (or consumed by) a REST endpoint,\nand the structure of each element is described by its <i>type</i>.\n</p>\n\n<pre>\nTo be able to test the service bellow you need to enable basic authentication over sso.\nThis happens by adding the following property to vmo.properties configuration file:<br />\n<pre>com.vmware.o11n.sso.basic-authentication.enabled = true</pre>\n</pre>\n",
"version" : "8.x"
"version" : "8.x"
},
},
"servers" : [ {
"servers" : [ {
"url" : "https://auto-a.vcf.lab/vco/api",
"url" : "https://vra.vcf.lab/vco/api",
"description" : "Generated server url"
"description" : "Generated server url"
} ],
} ],
"security" : [ {
"security" : [ {
"BearerAuth" : [ ]
"BearerAuth" : [ ]
}, {
}, {
"BasicAuth" : [ ]
"BasicAuth" : [ ]
} ],
} ],
"paths" : {
"paths" : {
"/workflows/{id}/content" : {
"/workflows/{id}/content" : {
"get" : {
"get" : {
"tags" : [ "Workflow Service" ],
"tags" : [ "Workflow Service" ],
"summary" : "Access workflow's schema",
"summary" : "Access workflow's schema",
"description" : "The schema data is returned and response Content-type is set to correct media type, for example \"Content-Type:application/json\"",
"description" : "The schema data is returned and response Content-type is set to correct media type, for example \"Content-Type:application/json\"",
"operationId" : "getWorkflowSchema",
"operationId" : "getWorkflowSchema",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful",
"description" : "The request is successful",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
}
}
}
}
},
},
"401" : {
"401" : {
"description" : "The user is not authorized",
"description" : "The user is not authorized",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
}
}
}
}
},
},
"404" : {
"404" : {
"description" : "Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow",
"description" : "Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
}
}
}
}
}
}
}
}
},
},
"put" : {
"put" : {
"tags" : [ "Workflow Service" ],
"tags" : [ "Workflow Service" ],
"summary" : "Update workflow's schema",
"summary" : "Update workflow's schema",
"description" : "Updates workflow's schema for a given workflow ID and schema",
"description" : "Updates workflow's schema for a given workflow ID and schema",
"operationId" : "updateWorkflowSchemaContent",
"operationId" : "updateWorkflowSchemaContent",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
}, {
}, {
"name" : "X-VRO-Changeset-Sha",
"name" : "X-VRO-Changeset-Sha",
"in" : "header",
"in" : "header",
"required" : false,
"required" : false,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"204" : {
"204" : {
"description" : "The request is successful"
"description" : "The request is successful"
},
},
"401" : {
"401" : {
"description" : "The user is not authorized"
"description" : "The user is not authorized"
},
},
"404" : {
"404" : {
"description" : "Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow"
"description" : "Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow"
}
}
}
}
}
}
},
},
"/workflows/validate/schema" : {
"/workflows/validate/schema" : {
"put" : {
"put" : {
"tags" : [ "Workflow Service" ],
"tags" : [ "Workflow Service" ],
"summary" : "Validate workflow content",
"summary" : "Validate workflow content",
"description" : "Validate provided workflow content",
"description" : "Validate provided workflow content",
"operationId" : "validate",
"operationId" : "validate",
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/schema-workflow"
"$ref" : "#/components/schemas/schema-workflow"
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "Validation completed",
"description" : "Validation completed",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsValidationMessageList"
"$ref" : "#/components/schemas/WsValidationMessageList"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsValidationMessageList"
"$ref" : "#/components/schemas/WsValidationMessageList"
}
}
}
}
}
}
}
}
}
}
}
}
},
},
"/user-search/{id}" : {
"/user-search/{id}" : {
"put" : {
"put" : {
"tags" : [ "User Search Service" ],
"tags" : [ "User Search Service" ],
"summary" : "Updates an existing user search",
"summary" : "Updates an existing user search",
"description" : "Updates the user search with the id provided in the model with the model's data. Can be used to update recent search usage.",
"description" : "Updates the user search with the id provided in the model with the model's data. Can be used to update recent search usage.",
"operationId" : "updateUserSearch",
"operationId" : "updateUserSearch",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful",
"description" : "The request is successful",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
}
}
}
}
},
},
"400" : {
"400" : {
"description" : "The provided object is invalid",
"description" : "The provided object is invalid",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
}
}
}
}
},
},
"401" : {
"401" : {
"description" : "The user is not authorized",
"description" : "The user is not authorized",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsUserSearch"
"$ref" : "#/components/schemas/WsUserSearch"
}
}
}
}
}
}
}
}
}
}
},
},
"delete" : {
"delete" : {
"tags" : [ "User Search Service" ],
"tags" : [ "User Search Service" ],
"summary" : "Deletes the user search with the provided ID",
"summary" : "Deletes the user search with the provided ID",
"description" : "Deletes the user search with the provided ID",
"description" : "Deletes the user search with the provided ID",
"operationId" : "deleteUserSearch",
"operationId" : "deleteUserSearch",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful"
"description" : "The request is successful"
},
},
"401" : {
"401" : {
"description" : "The user is not authorized"
"description" : "The user is not authorized"
},
},
"204" : {
"204" : {
"description" : "No Content"
"description" : "No Content"
}
}
}
}
}
}
},
},
"/resources/{id}" : {
"/resources/{id}" : {
"get" : {
"get" : {
"tags" : [ "Resource Service" ],
"tags" : [ "Resource Service" ],
"summary" : "Get resource",
"summary" : "Get resource",
"description" : "The returned definition contains base data for the resource.\nWhen this endpoint is called with the MIME type of the specified resource as the desired response content type, this operation is the equivalent of \"Export resource\":\nExports a resource by its ID. If the request is successful, the resource binary content is available in the body of response message. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported resource has the same internal format as the resource exported using VCF Operations Orchestrator client.",
"description" : "The returned definition contains base data for the resource.\nWhen this endpoint is called with the MIME type of the specified resource as the desired response content type, this operation is the equivalent of \"Export resource\":\nExports a resource by its ID. If the request is successful, the resource binary content is available in the body of response message. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported resource has the same internal format as the resource exported using Automation Orchestrator client.",
"operationId" : "getResource",
"operationId" : "getResource",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful",
"description" : "The request is successful",
"content" : {
"content" : {
"application/vnd.o11n.resource.metadata+json" : {
"application/vnd.o11n.resource.metadata+json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
},
},
"application/vnd.o11n.resource.metadata+xml" : {
"application/vnd.o11n.resource.metadata+xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
}
}
}
}
},
},
"401" : {
"401" : {
"description" : "User is not authorized",
"description" : "User is not authorized",
"content" : {
"content" : {
"application/vnd.o11n.resource.metadata+json" : {
"application/vnd.o11n.resource.metadata+json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
},
},
"application/vnd.o11n.resource.metadata+xml" : {
"application/vnd.o11n.resource.metadata+xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
}
}
}
}
},
},
"404" : {
"404" : {
"description" : "Cannot find resource with the specified ID.",
"description" : "Cannot find resource with the specified ID.",
"content" : {
"content" : {
"application/vnd.o11n.resource.metadata+json" : {
"application/vnd.o11n.resource.metadata+json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
},
},
"application/vnd.o11n.resource.metadata+xml" : {
"application/vnd.o11n.resource.metadata+xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
}
}
}
}
}
}
}
}
},
},
"put" : {
"put" : {
"tags" : [ "Resource Service" ],
"tags" : [ "Resource Service" ],
"summary" : "Update resource metadata",
"summary" : "Update resource metadata",
"description" : "Update resource metadata. Mime type can't be updated separately from content.",
"description" : "Update resource metadata. Mime type can't be updated separately from content.",
"operationId" : "updateResource",
"operationId" : "updateResource",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/Resource"
"$ref" : "#/components/schemas/Resource"
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful"
"description" : "The request is successful"
},
},
"400" : {
"400" : {
"description" : "The request is invalid"
"description" : "The request is invalid"
},
},
"401" : {
"401" : {
"description" : "User is not authorized"
"description" : "User is not authorized"
},
},
"404" : {
"404" : {
"description" : "Cannot find resource with the specified ID."
"description" : "Cannot find resource with the specified ID."
},
},
"204" : {
"204" : {
"description" : "No Content"
"description" : "No Content"
}
}
}
}
},
},
"post" : {
"post" : {
"tags" : [ "Resource Service" ],
"tags" : [ "Resource Service" ],
"summary" : "Update resource content",
"summary" : "Update resource content",
"description" : "Update resource content.",
"description" : "Update resource content.",
"operationId" : "updateResource_1",
"operationId" : "updateResource_1",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
}, {
}, {
"name" : "categoryId",
"name" : "categoryId",
"in" : "query",
"in" : "query",
"required" : false,
"required" : false,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
}, {
}, {
"name" : "X-VRO-Changeset-Sha",
"name" : "X-VRO-Changeset-Sha",
"in" : "header",
"in" : "header",
"required" : false,
"required" : false,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/octet-stream" : {
"application/octet-stream" : {
"schema" : {
"schema" : {
"required" : [ "file" ],
"required" : [ "file" ],
"type" : "object",
"type" : "object",
"properties" : {
"properties" : {
"file" : {
"file" : {
"type" : "string",
"type" : "string",
"format" : "binary"
"format" : "binary"
}
}
}
}
}
}
},
},
"multipart/form-data" : {
"multipart/form-data" : {
"schema" : {
"schema" : {
"required" : [ "file" ],
"required" : [ "file" ],
"type" : "object",
"type" : "object",
"properties" : {
"properties" : {
"file" : {
"file" : {
"type" : "string",
"type" : "string",
"format" : "binary"
"format" : "binary"
}
}
}
}
}
}
}
}
}
}
},
},
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful"
"description" : "The request is successful"
},
},
"401" : {
"401" : {
"description" : "User is not authorized"
"description" : "User is not authorized"
},
},
"404" : {
"404" : {
"description" : "Cannot find resource with the specified ID."
"description" : "Cannot find resource with the specified ID."
}
}
}
}
},
},
"delete" : {
"delete" : {
"tags" : [ "Resource Service" ],
"tags" : [ "Resource Service" ],
"summary" : "Delete resource",
"summary" : "Delete resource",
"description" : "If the resource is referenced by some workflow, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.",
"description" : "If the resource is referenced by some workflow, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.",
"operationId" : "deleteResource",
"operationId" : "deleteResource",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
}, {
}, {
"name" : "force",
"name" : "force",
"in" : "query",
"in" : "query",
"required" : false,
"required" : false,
"schema" : {
"schema" : {
"type" : "boolean",
"type" : "boolean",
"default" : false
"default" : false
}
}
} ],
} ],
"responses" : {
"responses" : {
"204" : {
"204" : {
"description" : "The request is successful"
"description" : "The request is successful"
},
},
"401" : {
"401" : {
"description" : "User is not authorized"
"description" : "User is not authorized"
},
},
"404" : {
"404" : {
"description" : "Cannot find an resource with the specified ID"
"description" : "Cannot find an resource with the specified ID"
}
}
}
}
}
}
},
},
"/policies/{id}" : {
"/policies/{id}" : {
"get" : {
"get" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Get policy",
"summary" : "Get policy",
"description" : "Get policy",
"description" : "Get policy",
"operationId" : "getPolicy",
"operationId" : "getPolicy",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful",
"description" : "The request is successful",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
}
}
}
}
},
},
"404" : {
"404" : {
"description" : "Cannot find a policy with the specified ID or the user does not have 'read' rights over it",
"description" : "Cannot find a policy with the specified ID or the user does not have 'read' rights over it",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
}
}
}
}
},
},
"401" : {
"401" : {
"description" : "The user is not authorized",
"description" : "The user is not authorized",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
}
}
}
}
}
}
}
}
},
},
"put" : {
"put" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Update policy",
"summary" : "Update policy",
"description" : "Updates the policy. Can be used to set startup behavior and priority",
"description" : "Updates the policy. Can be used to set startup behavior and priority",
"operationId" : "updatePolicy",
"operationId" : "updatePolicy",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"$ref" : "#/components/schemas/WsPolicy"
"$ref" : "#/components/schemas/WsPolicy"
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"204" : {
"204" : {
"description" : "No content"
"description" : "No content"
},
},
"400" : {
"400" : {
"description" : "The request is invalid"
"description" : "The request is invalid"
},
},
"401" : {
"401" : {
"description" : "The user is not authorized"
"description" : "The user is not authorized"
},
},
"404" : {
"404" : {
"description" : "Cannot find a policy with the specified ID or the user does not have 'update' rights over it"
"description" : "Cannot find a policy with the specified ID or the user does not have 'update' rights over it"
}
}
}
}
},
},
"delete" : {
"delete" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Delete policy",
"summary" : "Delete policy",
"description" : "Delete policy",
"description" : "Delete policy",
"operationId" : "deletePolicy",
"operationId" : "deletePolicy",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"404" : {
"404" : {
"description" : "Cannot find a policy with the specified ID or the user does not have 'delete' rights over it"
"description" : "Cannot find a policy with the specified ID or the user does not have 'delete' rights over it"
},
},
"204" : {
"204" : {
"description" : "No content"
"description" : "No content"
},
},
"401" : {
"401" : {
"description" : "The user is not authorized"
"description" : "The user is not authorized"
}
}
}
}
}
}
},
},
"/policies/{id}/state" : {
"/policies/{id}/state" : {
"get" : {
"get" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Get policy state",
"summary" : "Get policy state",
"description" : "Get policy state",
"description" : "Get policy state",
"operationId" : "getPolicyState",
"operationId" : "getPolicyState",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"responses" : {
"responses" : {
"200" : {
"200" : {
"description" : "The request is successful",
"description" : "The request is successful",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
}
}
}
}
},
},
"404" : {
"404" : {
"description" : "Cannot find a policy with the specified ID",
"description" : "Cannot find a policy with the specified ID",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
}
}
}
}
},
},
"401" : {
"401" : {
"description" : "The user is not authorized",
"description" : "The user is not authorized",
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
}
}
}
}
}
}
}
}
},
},
"put" : {
"put" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Update policy state",
"summary" : "Update policy state",
"description" : "Updates the policy state. Can be used to start or stop a policy",
"description" : "Updates the policy state. Can be used to start or stop a policy",
"operationId" : "updatePolicyState",
"operationId" : "updatePolicyState",
"parameters" : [ {
"parameters" : [ {
"name" : "id",
"name" : "id",
"in" : "path",
"in" : "path",
"required" : true,
"required" : true,
"schema" : {
"schema" : {
"type" : "string"
"type" : "string"
}
}
} ],
} ],
"requestBody" : {
"requestBody" : {
"content" : {
"content" : {
"application/json" : {
"application/json" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
},
},
"application/xml" : {
"application/xml" : {
"schema" : {
"schema" : {
"type" : "string",
"type" : "string",
"enum" : [ "started", "stopped", "stopping", "starting" ]
"enum" : [ "started", "stopped", "stopping", "starting" ]
}
}
}
}
},
},
"required" : true
"required" : true
},
},
"responses" : {
"responses" : {
"204" : {
"204" : {
"description" : "No content"
"description" : "No content"
},
},
"400" : {
"400" : {
"description" : "The request is invalid"
"description" : "The request is invalid"
},
},
"401" : {
"401" : {
"description" : "The user is not authorized"
"description" : "The user is not authorized"
},
},
"404" : {
"404" : {
"description" : "Cannot find a policy with the specified ID or the user does not have 'update' rights over it"
"description" : "Cannot find a policy with the specified ID or the user does not have 'update' rights over it"
}
}
}
}
}
}
},
},
"/policies/templates/{id}" : {
"/policies/templates/{id}" : {
"get" : {
"get" : {
"tags" : [ "Policy Service" ],
"tags" : [ "Policy Service" ],
"summary" : "Get policy template",
"summary" : "Get policy template",
"description" : "Get policy template\nWhen a request is sent to this endpoint with a desir
"description" : "Get policy template\nWhen a request is sent to this endpoint with a desired response content type of \"application/vcoob