{ "openapi": "3.0.2", "info": { "description": "Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and\n3rd party IT infrastructure. This platform offers an intelligent level of management that enables\nIT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior\ngenerations of tools. Cisco Intersight provides an integrated and intuitive management experience for\nresources in the traditional data center as well as at the edge. With flexible deployment options to address\ncomplex security needs, getting started with Intersight is quick and easy.\nCisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment,\nconfiguration, and ongoing maintenance. The model-based deployment works for a single system in a remote\nlocation or hundreds of systems in a data center and enables rapid, standardized configuration and deployment.\nIt also streamlines maintaining those systems whether you are working with small or very large configurations.\nThe Intersight OpenAPI document defines the complete set of properties that are returned in the\nHTTP response. From that perspective, a client can expect that no additional properties are returned,\nunless these properties are explicitly defined in the OpenAPI document.\nHowever, when a client uses an older version of the Intersight OpenAPI document, the server may\nsend additional properties because the software is more recent than the client. In that case, the client\nmay receive properties that it does not know about.\nSome generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document.\nThis document was created on 2026-08-07T06:46:04Z.", "version": "1.0.11-20260807064027971", "title": "Cisco Intersight Orchestrator", "license": { "name": "Apache License, Version 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "contact": { "name": "Intersight API support", "url": "https://intersight.com/help", "email": "intersight@cisco.com" } }, "externalDocs": { "url": "/apidocs", "description": "Online documentation for the Intersight APIs" }, "servers": [ { "url": "https://{server}", "variables": { "server": { "default": "intersight.com" } }, "description": "The Intersight URL for the cloud-based infrastructure management APIs." } ], "tags": [ { "name": "connectorpack" }, { "name": "convergedinfra" }, { "name": "iaas" }, { "name": "ucsd" }, { "name": "workflow" } ], "paths": { "/api/v1/connectorpack/ConnectorPackUpgrades": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "GetConnectorpackConnectorPackUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.ConnectorPackUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'connectorpack.ConnectorPackUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "connectorpack" ], "summary": "Create a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "CreateConnectorpackConnectorPackUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.connectorpack.ConnectorPackUpgrade", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'connectorpack.ConnectorPackUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'connectorpack.ConnectorPackUpgrade' resource was created as requested. The 'connectorpack.ConnectorPackUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } } }, "links": { "GetConnectorpackConnectorPackUpgradeByMoid": { "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/ConnectorPackUpgrades/{Moid}": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.ConnectorPackUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'connectorpack.ConnectorPackUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConnectorpackConnectorPackUpgradeByMoid": { "operationId": "GetConnectorpackConnectorPackUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/ConnectorPackUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "connectorpack" ], "summary": "Delete a 'connectorpack.ConnectorPackUpgrade' resource.", "operationId": "DeleteConnectorpackConnectorPackUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.connectorpack.ConnectorPackUpgrade", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/UpgradeImpacts": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.UpgradeImpact' resource.", "operationId": "GetConnectorpackUpgradeImpactList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.UpgradeImpact", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'connectorpack.UpgradeImpact' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/connectorpack/UpgradeImpacts/{Moid}": { "get": { "tags": [ "connectorpack" ], "summary": "Read a 'connectorpack.UpgradeImpact' resource.", "operationId": "GetConnectorpackUpgradeImpactByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.connectorpack.UpgradeImpact", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'connectorpack.UpgradeImpact' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConnectorpackUpgradeImpactByMoid": { "operationId": "GetConnectorpackUpgradeImpactByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/connectorpack/UpgradeImpacts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/AdapterComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.AdapterComplianceDetails' resource.", "operationId": "GetConvergedinfraAdapterComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.AdapterComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.AdapterComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/AdapterComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.AdapterComplianceDetails' resource.", "operationId": "GetConvergedinfraAdapterComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.AdapterComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.AdapterComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraAdapterComplianceDetailsByMoid": { "operationId": "GetConvergedinfraAdapterComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/AdapterComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/Pods": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.Pod' resource.", "operationId": "GetConvergedinfraPodList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.Pod", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.Pod' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/Pods/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.Pod' resource.", "operationId": "GetConvergedinfraPodByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.Pod", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.Pod' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "convergedinfra" ], "summary": "Update a 'convergedinfra.Pod' resource.", "operationId": "UpdateConvergedinfraPod", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Read-Only", "UPDATE.convergedinfra.Pod" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'convergedinfra.Pod' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'convergedinfra.Pod' resource was modified as requested. The 'convergedinfra.Pod' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "convergedinfra" ], "summary": "Update a 'convergedinfra.Pod' resource.", "operationId": "PatchConvergedinfraPod", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Read-Only", "UPDATE.convergedinfra.Pod" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'convergedinfra.Pod' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'convergedinfra.Pod' resource was patched as requested. The 'convergedinfra.Pod' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.Pod" } } }, "links": { "GetConvergedinfraPodByMoid": { "operationId": "GetConvergedinfraPodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/Pods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/PodComplianceInfos": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.PodComplianceInfo' resource.", "operationId": "GetConvergedinfraPodComplianceInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.PodComplianceInfo", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.PodComplianceInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/PodComplianceInfos/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.PodComplianceInfo' resource.", "operationId": "GetConvergedinfraPodComplianceInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.PodComplianceInfo", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.PodComplianceInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraPodComplianceInfoByMoid": { "operationId": "GetConvergedinfraPodComplianceInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/PodComplianceInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/ServerComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.ServerComplianceDetails' resource.", "operationId": "GetConvergedinfraServerComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.ServerComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.ServerComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/ServerComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.ServerComplianceDetails' resource.", "operationId": "GetConvergedinfraServerComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.ServerComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.ServerComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraServerComplianceDetailsByMoid": { "operationId": "GetConvergedinfraServerComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/ServerComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/StorageComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.StorageComplianceDetails' resource.", "operationId": "GetConvergedinfraStorageComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.StorageComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.StorageComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/StorageComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.StorageComplianceDetails' resource.", "operationId": "GetConvergedinfraStorageComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.StorageComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.StorageComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraStorageComplianceDetailsByMoid": { "operationId": "GetConvergedinfraStorageComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/StorageComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/SwitchComplianceDetails": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.SwitchComplianceDetails' resource.", "operationId": "GetConvergedinfraSwitchComplianceDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.SwitchComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'convergedinfra.SwitchComplianceDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/convergedinfra/SwitchComplianceDetails/{Moid}": { "get": { "tags": [ "convergedinfra" ], "summary": "Read a 'convergedinfra.SwitchComplianceDetails' resource.", "operationId": "GetConvergedinfraSwitchComplianceDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.convergedinfra.SwitchComplianceDetails", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'convergedinfra.SwitchComplianceDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetConvergedinfraSwitchComplianceDetailsByMoid": { "operationId": "GetConvergedinfraSwitchComplianceDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/convergedinfra/SwitchComplianceDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ConnectorPacks": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ConnectorPack' resource.", "operationId": "GetIaasConnectorPackList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ConnectorPack" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.ConnectorPack' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ConnectorPack.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ConnectorPacks/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ConnectorPack' resource.", "operationId": "GetIaasConnectorPackByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ConnectorPack" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.ConnectorPack' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ConnectorPack" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasConnectorPackByMoid": { "operationId": "GetIaasConnectorPackByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ConnectorPacks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/CustomTaskInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.CustomTaskInfo' resource.", "operationId": "GetIaasCustomTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.CustomTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.CustomTaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.CustomTaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/CustomTaskInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.CustomTaskInfo' resource.", "operationId": "GetIaasCustomTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.CustomTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.CustomTaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.CustomTaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasCustomTaskInfoByMoid": { "operationId": "GetIaasCustomTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/CustomTaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DeviceStatuses": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DeviceStatus' resource.", "operationId": "GetIaasDeviceStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DeviceStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.DeviceStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DeviceStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DeviceStatuses/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DeviceStatus' resource.", "operationId": "GetIaasDeviceStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DeviceStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.DeviceStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DeviceStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasDeviceStatusByMoid": { "operationId": "GetIaasDeviceStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DeviceStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DiagnosticMessages": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DiagnosticMessages' resource.", "operationId": "GetIaasDiagnosticMessagesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DiagnosticMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.DiagnosticMessages' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DiagnosticMessages.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/DiagnosticMessages/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.DiagnosticMessages' resource.", "operationId": "GetIaasDiagnosticMessagesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.DiagnosticMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.DiagnosticMessages' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.DiagnosticMessages" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasDiagnosticMessagesByMoid": { "operationId": "GetIaasDiagnosticMessagesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/DiagnosticMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/LicenseInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.LicenseInfo' resource.", "operationId": "GetIaasLicenseInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.LicenseInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.LicenseInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/LicenseInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.LicenseInfo' resource.", "operationId": "GetIaasLicenseInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.LicenseInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.LicenseInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasLicenseInfoByMoid": { "operationId": "GetIaasLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/MostRunTasks": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.MostRunTasks' resource.", "operationId": "GetIaasMostRunTasksList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.MostRunTasks" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.MostRunTasks' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.MostRunTasks.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/MostRunTasks/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.MostRunTasks' resource.", "operationId": "GetIaasMostRunTasksByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.MostRunTasks" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.MostRunTasks' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.MostRunTasks" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasMostRunTasksByMoid": { "operationId": "GetIaasMostRunTasksByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/MostRunTasks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ServiceRequests": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ServiceRequest' resource.", "operationId": "GetIaasServiceRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.ServiceRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ServiceRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/ServiceRequests/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.ServiceRequest' resource.", "operationId": "GetIaasServiceRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.ServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.ServiceRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.ServiceRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasServiceRequestByMoid": { "operationId": "GetIaasServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/ServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/SystemTaskInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.SystemTaskInfo' resource.", "operationId": "GetIaasSystemTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.SystemTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.SystemTaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.SystemTaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/SystemTaskInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.SystemTaskInfo' resource.", "operationId": "GetIaasSystemTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.SystemTaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.SystemTaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.SystemTaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasSystemTaskInfoByMoid": { "operationId": "GetIaasSystemTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/SystemTaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdInfos": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdInfo' resource.", "operationId": "GetIaasUcsdInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iaas.UcsdInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdInfos/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdInfo' resource.", "operationId": "GetIaasUcsdInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iaas.UcsdInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iaas" ], "summary": "Update a 'iaas.UcsdInfo' resource.", "operationId": "UpdateIaasUcsdInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iaas.UcsdInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iaas.UcsdInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was modified as requested. The 'iaas.UcsdInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iaas" ], "summary": "Update a 'iaas.UcsdInfo' resource.", "operationId": "PatchIaasUcsdInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iaas.UcsdInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iaas.UcsdInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iaas.UcsdInfo' resource was patched as requested. The 'iaas.UcsdInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdInfo" } } }, "links": { "GetIaasUcsdInfoByMoid": { "operationId": "GetIaasUcsdInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdManagedInfras": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdManagedInfra' resource.", "operationId": "GetIaasUcsdManagedInfraList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdManagedInfra" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdManagedInfra' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdManagedInfras/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdManagedInfra' resource.", "operationId": "GetIaasUcsdManagedInfraByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdManagedInfra" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdManagedInfra' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdManagedInfraByMoid": { "operationId": "GetIaasUcsdManagedInfraByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdManagedInfras/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdMessages": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdMessages' resource.", "operationId": "GetIaasUcsdMessagesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iaas.UcsdMessages' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdMessages.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iaas/UcsdMessages/{Moid}": { "get": { "tags": [ "iaas" ], "summary": "Read a 'iaas.UcsdMessages' resource.", "operationId": "GetIaasUcsdMessagesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iaas.UcsdMessages" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iaas.UcsdMessages' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iaas.UcsdMessages" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIaasUcsdMessagesByMoid": { "operationId": "GetIaasUcsdMessagesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iaas/UcsdMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ucsd/BackupInfos": { "get": { "tags": [ "ucsd" ], "summary": "Read a 'ucsd.BackupInfo' resource.", "operationId": "GetUcsdBackupInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.ucsd.BackupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ucsd.BackupInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ucsd.BackupInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ucsd/BackupInfos/{Moid}": { "get": { "tags": [ "ucsd" ], "summary": "Read a 'ucsd.BackupInfo' resource.", "operationId": "GetUcsdBackupInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.ucsd.BackupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ucsd.BackupInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ucsd.BackupInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUcsdBackupInfoByMoid": { "operationId": "GetUcsdBackupInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ucsd/BackupInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ucsd" ], "summary": "Delete a 'ucsd.BackupInfo' resource.", "operationId": "DeleteUcsdBackupInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ucsd.BackupInfo", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/AnsibleBatchExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "GetWorkflowAnsibleBatchExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.AnsibleBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.AnsibleBatchExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "CreateWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.AnsibleBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was created as requested. The 'workflow.AnsibleBatchExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/AnsibleBatchExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.AnsibleBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.AnsibleBatchExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "UpdateWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.AnsibleBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was modified as requested. The 'workflow.AnsibleBatchExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "PatchWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.AnsibleBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.AnsibleBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.AnsibleBatchExecutor' resource was patched as requested. The 'workflow.AnsibleBatchExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" } } }, "links": { "GetWorkflowAnsibleBatchExecutorByMoid": { "operationId": "GetWorkflowAnsibleBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/AnsibleBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.AnsibleBatchExecutor' resource.", "operationId": "DeleteWorkflowAnsibleBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.AnsibleBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/BatchApiExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.BatchApiExecutor' resource.", "operationId": "GetWorkflowBatchApiExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.BatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.BatchApiExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.BatchApiExecutor' resource.", "operationId": "CreateWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.BatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was created as requested. The 'workflow.BatchApiExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/BatchApiExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.BatchApiExecutor' resource.", "operationId": "GetWorkflowBatchApiExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.BatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.BatchApiExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.BatchApiExecutor' resource.", "operationId": "UpdateWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.BatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was modified as requested. The 'workflow.BatchApiExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.BatchApiExecutor' resource.", "operationId": "PatchWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.BatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.BatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.BatchApiExecutor' resource was patched as requested. The 'workflow.BatchApiExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" } } }, "links": { "GetWorkflowBatchApiExecutorByMoid": { "operationId": "GetWorkflowBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/BatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.BatchApiExecutor' resource.", "operationId": "DeleteWorkflowBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.BatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Catalogs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Catalog' resource.", "operationId": "GetWorkflowCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.Catalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Catalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Catalogs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Catalog' resource.", "operationId": "GetWorkflowCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.Catalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Catalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogByMoid": { "operationId": "GetWorkflowCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Catalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogItemDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogItemDefinition' resource.", "operationId": "GetWorkflowCatalogItemDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CatalogItemDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CatalogItemDefinition' resource.", "operationId": "CreateWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CatalogItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was created as requested. The 'workflow.CatalogItemDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogItemDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogItemDefinition' resource.", "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CatalogItemDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogItemDefinition' resource.", "operationId": "UpdateWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "UPDATE.workflow.CatalogItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was modified as requested. The 'workflow.CatalogItemDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogItemDefinition' resource.", "operationId": "PatchWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "UPDATE.workflow.CatalogItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogItemDefinition' resource was patched as requested. The 'workflow.CatalogItemDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } } }, "links": { "GetWorkflowCatalogItemDefinitionByMoid": { "operationId": "GetWorkflowCatalogItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CatalogItemDefinition' resource.", "operationId": "DeleteWorkflowCatalogItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CatalogItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogServiceRequests": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogServiceRequest' resource.", "operationId": "GetWorkflowCatalogServiceRequestList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogServiceRequest", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CatalogServiceRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CatalogServiceRequest' resource.", "operationId": "CreateWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CatalogServiceRequest", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was created as requested. The 'workflow.CatalogServiceRequest' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CatalogServiceRequests/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CatalogServiceRequest' resource.", "operationId": "GetWorkflowCatalogServiceRequestByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Operator", "READ.workflow.CatalogServiceRequest", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CatalogServiceRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogServiceRequest' resource.", "operationId": "UpdateWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator", "UPDATE.workflow.CatalogServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was modified as requested. The 'workflow.CatalogServiceRequest' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CatalogServiceRequest' resource.", "operationId": "PatchWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Service Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Service Operator", "UPDATE.workflow.CatalogServiceRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CatalogServiceRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CatalogServiceRequest' resource was patched as requested. The 'workflow.CatalogServiceRequest' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } } }, "links": { "GetWorkflowCatalogServiceRequestByMoid": { "operationId": "GetWorkflowCatalogServiceRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CatalogServiceRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CatalogServiceRequest' resource.", "operationId": "DeleteWorkflowCatalogServiceRequest", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CatalogServiceRequest", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "ROLE.Account Administrator", "ROLE.Catalog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CustomDataTypeDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "GetWorkflowCustomDataTypeDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.CustomDataTypeDefinition", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.CustomDataTypeDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "CreateWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.CustomDataTypeDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was created as requested. The 'workflow.CustomDataTypeDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/CustomDataTypeDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.CustomDataTypeDefinition", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.CustomDataTypeDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "UpdateWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.CustomDataTypeDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was modified as requested. The 'workflow.CustomDataTypeDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "PatchWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.CustomDataTypeDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.CustomDataTypeDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.CustomDataTypeDefinition' resource was patched as requested. The 'workflow.CustomDataTypeDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } } }, "links": { "GetWorkflowCustomDataTypeDefinitionByMoid": { "operationId": "GetWorkflowCustomDataTypeDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/CustomDataTypeDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.CustomDataTypeDefinition' resource.", "operationId": "DeleteWorkflowCustomDataTypeDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.CustomDataTypeDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ErrorResponseHandlers": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ErrorResponseHandler' resource.", "operationId": "GetWorkflowErrorResponseHandlerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Workflow Definitions", "READ.workflow.ErrorResponseHandler", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ErrorResponseHandler' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ErrorResponseHandler' resource.", "operationId": "CreateWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ErrorResponseHandler", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was created as requested. The 'workflow.ErrorResponseHandler' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ErrorResponseHandlers/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ErrorResponseHandler' resource.", "operationId": "GetWorkflowErrorResponseHandlerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Workflow Definitions", "READ.workflow.ErrorResponseHandler", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ErrorResponseHandler' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ErrorResponseHandler' resource.", "operationId": "UpdateWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.ErrorResponseHandler" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was modified as requested. The 'workflow.ErrorResponseHandler' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ErrorResponseHandler' resource.", "operationId": "PatchWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.ErrorResponseHandler" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ErrorResponseHandler' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ErrorResponseHandler' resource was patched as requested. The 'workflow.ErrorResponseHandler' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler" } } }, "links": { "GetWorkflowErrorResponseHandlerByMoid": { "operationId": "GetWorkflowErrorResponseHandlerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ErrorResponseHandlers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ErrorResponseHandler' resource.", "operationId": "DeleteWorkflowErrorResponseHandler", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ErrorResponseHandler", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/PowerShellBatchApiExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "GetWorkflowPowerShellBatchApiExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.PowerShellBatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.PowerShellBatchApiExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "CreateWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.PowerShellBatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was created as requested. The 'workflow.PowerShellBatchApiExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.PowerShellBatchApiExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.PowerShellBatchApiExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "UpdateWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.PowerShellBatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was modified as requested. The 'workflow.PowerShellBatchApiExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "PatchWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.PowerShellBatchApiExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.PowerShellBatchApiExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.PowerShellBatchApiExecutor' resource was patched as requested. The 'workflow.PowerShellBatchApiExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.PowerShellBatchApiExecutor" } } }, "links": { "GetWorkflowPowerShellBatchApiExecutorByMoid": { "operationId": "GetWorkflowPowerShellBatchApiExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/PowerShellBatchApiExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.PowerShellBatchApiExecutor' resource.", "operationId": "DeleteWorkflowPowerShellBatchApiExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.PowerShellBatchApiExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/RollbackWorkflows": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.RollbackWorkflow' resource.", "operationId": "GetWorkflowRollbackWorkflowList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.RollbackWorkflow", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.RollbackWorkflow' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.RollbackWorkflow' resource.", "operationId": "CreateWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.RollbackWorkflow", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was created as requested. The 'workflow.RollbackWorkflow' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/RollbackWorkflows/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.RollbackWorkflow' resource.", "operationId": "GetWorkflowRollbackWorkflowByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.RollbackWorkflow", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.RollbackWorkflow' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.RollbackWorkflow' resource.", "operationId": "UpdateWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator", "UPDATE.workflow.RollbackWorkflow" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was modified as requested. The 'workflow.RollbackWorkflow' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.RollbackWorkflow' resource.", "operationId": "PatchWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator", "UPDATE.workflow.RollbackWorkflow" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.RollbackWorkflow' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.RollbackWorkflow' resource was patched as requested. The 'workflow.RollbackWorkflow' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.RollbackWorkflow" } } }, "links": { "GetWorkflowRollbackWorkflowByMoid": { "operationId": "GetWorkflowRollbackWorkflowByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/RollbackWorkflows/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.RollbackWorkflow' resource.", "operationId": "DeleteWorkflowRollbackWorkflow", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.RollbackWorkflow", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "GetWorkflowServiceItemActionDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemActionDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "CreateWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemActionDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was created as requested. The 'workflow.ServiceItemActionDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemActionDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "UpdateWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemActionDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was modified as requested. The 'workflow.ServiceItemActionDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "PatchWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemActionDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionDefinition' resource was patched as requested. The 'workflow.ServiceItemActionDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionDefinition" } } }, "links": { "GetWorkflowServiceItemActionDefinitionByMoid": { "operationId": "GetWorkflowServiceItemActionDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemActionDefinition' resource.", "operationId": "DeleteWorkflowServiceItemActionDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemActionDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionInstances": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionInstance' resource.", "operationId": "GetWorkflowServiceItemActionInstanceList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemActionInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemActionInstance' resource.", "operationId": "CreateWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemActionInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was created as requested. The 'workflow.ServiceItemActionInstance' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemActionInstances/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemActionInstance' resource.", "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemActionInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemActionInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionInstance' resource.", "operationId": "UpdateWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemActionInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was modified as requested. The 'workflow.ServiceItemActionInstance' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemActionInstance' resource.", "operationId": "PatchWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Delete integrated systems", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Run interoperability checks", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemActionInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemActionInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemActionInstance' resource was patched as requested. The 'workflow.ServiceItemActionInstance' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance" } } }, "links": { "GetWorkflowServiceItemActionInstanceByMoid": { "operationId": "GetWorkflowServiceItemActionInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemActionInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemActionInstance' resource.", "operationId": "DeleteWorkflowServiceItemActionInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemActionInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Delete integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemAttributes": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemAttribute' resource.", "operationId": "GetWorkflowServiceItemAttributeList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemAttribute", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemAttribute' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemAttribute.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemAttributes/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemAttribute' resource.", "operationId": "GetWorkflowServiceItemAttributeByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemAttribute", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemAttribute' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemAttribute" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemAttributeByMoid": { "operationId": "GetWorkflowServiceItemAttributeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemAttributes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemDefinition' resource.", "operationId": "GetWorkflowServiceItemDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemDefinition' resource.", "operationId": "CreateWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was created as requested. The 'workflow.ServiceItemDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemDefinition' resource.", "operationId": "GetWorkflowServiceItemDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemDefinition", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemDefinition' resource.", "operationId": "UpdateWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was modified as requested. The 'workflow.ServiceItemDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemDefinition' resource.", "operationId": "PatchWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "UPDATE.workflow.ServiceItemDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemDefinition' resource was patched as requested. The 'workflow.ServiceItemDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemDefinition" } } }, "links": { "GetWorkflowServiceItemDefinitionByMoid": { "operationId": "GetWorkflowServiceItemDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemDefinition' resource.", "operationId": "DeleteWorkflowServiceItemDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemDefinition", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckDefinition' resource.", "operationId": "GetWorkflowServiceItemHealthCheckDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.workflow.ServiceItemHealthCheckDefinition", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemHealthCheckDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckDefinition' resource.", "operationId": "GetWorkflowServiceItemHealthCheckDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "READ.workflow.ServiceItemHealthCheckDefinition", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemHealthCheckDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemHealthCheckDefinitionByMoid": { "operationId": "GetWorkflowServiceItemHealthCheckDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckExecutions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckExecution' resource.", "operationId": "GetWorkflowServiceItemHealthCheckExecutionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.ServiceItemHealthCheckExecution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemHealthCheckExecution' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckExecution.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemHealthCheckExecution' resource.", "operationId": "GetWorkflowServiceItemHealthCheckExecutionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.ServiceItemHealthCheckExecution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemHealthCheckExecution' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemHealthCheckExecution" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemHealthCheckExecutionByMoid": { "operationId": "GetWorkflowServiceItemHealthCheckExecutionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemInstances": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemInstance' resource.", "operationId": "GetWorkflowServiceItemInstanceList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemInstance' resource.", "operationId": "CreateWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Create integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was created as requested. The 'workflow.ServiceItemInstance' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemInstances/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemInstance' resource.", "operationId": "GetWorkflowServiceItemInstanceByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemInstance", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemInstance' resource.", "operationId": "UpdateWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was modified as requested. The 'workflow.ServiceItemInstance' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemInstance' resource.", "operationId": "PatchWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Edit integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemInstance' resource was patched as requested. The 'workflow.ServiceItemInstance' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemInstance" } } }, "links": { "GetWorkflowServiceItemInstanceByMoid": { "operationId": "GetWorkflowServiceItemInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemInstance' resource.", "operationId": "DeleteWorkflowServiceItemInstance", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemInstance", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Catalog User", "PRIVSET.Delete integrated systems", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Catalog User", "ROLE.Integrated Systems Administrator", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemOutputs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemOutput' resource.", "operationId": "GetWorkflowServiceItemOutputList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemOutput", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.ServiceItemOutput' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.ServiceItemOutput' resource.", "operationId": "CreateWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.ServiceItemOutput", "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was created as requested. The 'workflow.ServiceItemOutput' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/ServiceItemOutputs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.ServiceItemOutput' resource.", "operationId": "GetWorkflowServiceItemOutputByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Integrated Systems Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only integrated systems", "PRIVSET.Workload Operator", "READ.workflow.ServiceItemOutput", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Integrated Systems Operator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.ServiceItemOutput' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemOutput' resource.", "operationId": "UpdateWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemOutput" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was modified as requested. The 'workflow.ServiceItemOutput' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.ServiceItemOutput' resource.", "operationId": "PatchWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator", "UPDATE.workflow.ServiceItemOutput" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.ServiceItemOutput' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.ServiceItemOutput' resource was patched as requested. The 'workflow.ServiceItemOutput' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.ServiceItemOutput" } } }, "links": { "GetWorkflowServiceItemOutputByMoid": { "operationId": "GetWorkflowServiceItemOutputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/ServiceItemOutputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.ServiceItemOutput' resource.", "operationId": "DeleteWorkflowServiceItemOutput", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.ServiceItemOutput", "PRIVSET.Account Administrator", "PRIVSET.Integrated Systems Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Integrated Systems Administrator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/SshBatchExecutors": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.SshBatchExecutor' resource.", "operationId": "GetWorkflowSshBatchExecutorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.SshBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.SshBatchExecutor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.SshBatchExecutor' resource.", "operationId": "CreateWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.SshBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was created as requested. The 'workflow.SshBatchExecutor' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/SshBatchExecutors/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.SshBatchExecutor' resource.", "operationId": "GetWorkflowSshBatchExecutorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.SshBatchExecutor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.SshBatchExecutor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.SshBatchExecutor' resource.", "operationId": "UpdateWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.SshBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was modified as requested. The 'workflow.SshBatchExecutor' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.SshBatchExecutor' resource.", "operationId": "PatchWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.SshBatchExecutor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.SshBatchExecutor' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.SshBatchExecutor' resource was patched as requested. The 'workflow.SshBatchExecutor' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.SshBatchExecutor" } } }, "links": { "GetWorkflowSshBatchExecutorByMoid": { "operationId": "GetWorkflowSshBatchExecutorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/SshBatchExecutors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.SshBatchExecutor' resource.", "operationId": "DeleteWorkflowSshBatchExecutor", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.SshBatchExecutor", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDebugLogs": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDebugLog' resource.", "operationId": "GetWorkflowTaskDebugLogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "READ.workflow.TaskDebugLog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskDebugLog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDebugLog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDebugLogs/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDebugLog' resource.", "operationId": "GetWorkflowTaskDebugLogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "READ.workflow.TaskDebugLog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskDebugLog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDebugLog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskDebugLogByMoid": { "operationId": "GetWorkflowTaskDebugLogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDebugLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDefinition' resource.", "operationId": "GetWorkflowTaskDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TaskDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TaskDefinition' resource.", "operationId": "CreateWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TaskDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was created as requested. The 'workflow.TaskDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskDefinition' resource.", "operationId": "GetWorkflowTaskDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TaskDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskDefinition' resource.", "operationId": "UpdateWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.TaskDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was modified as requested. The 'workflow.TaskDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskDefinition' resource.", "operationId": "PatchWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.TaskDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskDefinition' resource was patched as requested. The 'workflow.TaskDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskDefinition" } } }, "links": { "GetWorkflowTaskDefinitionByMoid": { "operationId": "GetWorkflowTaskDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.TaskDefinition' resource.", "operationId": "DeleteWorkflowTaskDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.TaskDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskInfos": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskInfo' resource.", "operationId": "GetWorkflowTaskInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.TaskInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskInfos/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskInfo' resource.", "operationId": "GetWorkflowTaskInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.TaskInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskInfo' resource.", "operationId": "UpdateWorkflowTaskInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.TaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was modified as requested. The 'workflow.TaskInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.TaskInfo' resource.", "operationId": "PatchWorkflowTaskInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.TaskInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.TaskInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TaskInfo' resource was patched as requested. The 'workflow.TaskInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskInfo" } } }, "links": { "GetWorkflowTaskInfoByMoid": { "operationId": "GetWorkflowTaskInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskMetadata' resource.", "operationId": "GetWorkflowTaskMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.TaskMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TaskMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TaskMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TaskMetadata' resource.", "operationId": "GetWorkflowTaskMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.TaskMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TaskMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TaskMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTaskMetadataByMoid": { "operationId": "GetWorkflowTaskMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TaskMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateEvaluations": { "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TemplateEvaluation' resource.", "operationId": "CreateWorkflowTemplateEvaluation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TemplateEvaluation", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TemplateEvaluation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateEvaluation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TemplateEvaluation' resource was created as requested. The 'workflow.TemplateEvaluation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateEvaluation" } } }, "links": { "GetWorkflowTemplateEvaluationByMoid": { "operationId": "GetWorkflowTemplateEvaluationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateEvaluations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateFunctionMeta": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TemplateFunctionMeta' resource.", "operationId": "GetWorkflowTemplateFunctionMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TemplateFunctionMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.TemplateFunctionMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateFunctionMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateFunctionMeta/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.TemplateFunctionMeta' resource.", "operationId": "GetWorkflowTemplateFunctionMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.TemplateFunctionMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.TemplateFunctionMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateFunctionMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowTemplateFunctionMetaByMoid": { "operationId": "GetWorkflowTemplateFunctionMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateFunctionMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/TemplateParsers": { "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.TemplateParser' resource.", "operationId": "CreateWorkflowTemplateParser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.TemplateParser", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.TemplateParser' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateParser" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.TemplateParser' resource was created as requested. The 'workflow.TemplateParser' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.TemplateParser" } } }, "links": { "GetWorkflowTemplateParserByMoid": { "operationId": "GetWorkflowTemplateParserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/TemplateParsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/UiDisplayMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.UiDisplayMetadata' resource.", "operationId": "GetWorkflowUiDisplayMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.UiDisplayMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.UiDisplayMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.UiDisplayMetadata' resource.", "operationId": "CreateWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.UiDisplayMetadata", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was created as requested. The 'workflow.UiDisplayMetadata' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/UiDisplayMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.UiDisplayMetadata' resource.", "operationId": "GetWorkflowUiDisplayMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.UiDisplayMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.UiDisplayMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.UiDisplayMetadata' resource.", "operationId": "UpdateWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.UiDisplayMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was modified as requested. The 'workflow.UiDisplayMetadata' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.UiDisplayMetadata' resource.", "operationId": "PatchWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.UiDisplayMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.UiDisplayMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.UiDisplayMetadata' resource was patched as requested. The 'workflow.UiDisplayMetadata' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.UiDisplayMetadata" } } }, "links": { "GetWorkflowUiDisplayMetadataByMoid": { "operationId": "GetWorkflowUiDisplayMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/UiDisplayMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.UiDisplayMetadata' resource.", "operationId": "DeleteWorkflowUiDisplayMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.UiDisplayMetadata", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Variables": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Variable' resource.", "operationId": "GetWorkflowVariableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Variable", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.Variable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.Variable' resource.", "operationId": "CreateWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.Variable", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was created as requested. The 'workflow.Variable' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/Variables/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.Variable' resource.", "operationId": "GetWorkflowVariableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.Variable", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.Variable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.Variable' resource.", "operationId": "UpdateWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.Variable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was modified as requested. The 'workflow.Variable' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.Variable' resource.", "operationId": "PatchWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.Variable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.Variable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.Variable' resource was patched as requested. The 'workflow.Variable' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.Variable" } } }, "links": { "GetWorkflowVariableByMoid": { "operationId": "GetWorkflowVariableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/Variables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.Variable' resource.", "operationId": "DeleteWorkflowVariable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.Variable", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowDefinitions": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowDefinition' resource.", "operationId": "GetWorkflowWorkflowDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.WorkflowDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.WorkflowDefinition' resource.", "operationId": "CreateWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.WorkflowDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was created as requested. The 'workflow.WorkflowDefinition' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowDefinitions/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowDefinition' resource.", "operationId": "GetWorkflowWorkflowDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "READ.workflow.WorkflowDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowDefinition' resource.", "operationId": "UpdateWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was modified as requested. The 'workflow.WorkflowDefinition' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowDefinition' resource.", "operationId": "PatchWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowDefinition' resource was patched as requested. The 'workflow.WorkflowDefinition' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowDefinition" } } }, "links": { "GetWorkflowWorkflowDefinitionByMoid": { "operationId": "GetWorkflowWorkflowDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.WorkflowDefinition' resource.", "operationId": "DeleteWorkflowWorkflowDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.WorkflowDefinition", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowInfos": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowInfo' resource.", "operationId": "GetWorkflowWorkflowInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.WorkflowInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Create a 'workflow.WorkflowInfo' resource.", "operationId": "CreateWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workflow.WorkflowInfo", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was created as requested. The 'workflow.WorkflowInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowInfos/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowInfo' resource.", "operationId": "GetWorkflowWorkflowInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.workflow.WorkflowInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowInfo' resource.", "operationId": "UpdateWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was modified as requested. The 'workflow.WorkflowInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "workflow" ], "summary": "Update a 'workflow.WorkflowInfo' resource.", "operationId": "PatchWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator", "UPDATE.workflow.WorkflowInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workflow.WorkflowInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workflow.WorkflowInfo' resource was patched as requested. The 'workflow.WorkflowInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowInfo" } } }, "links": { "GetWorkflowWorkflowInfoByMoid": { "operationId": "GetWorkflowWorkflowInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "workflow" ], "summary": "Delete a 'workflow.WorkflowInfo' resource.", "operationId": "DeleteWorkflowWorkflowInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workflow.WorkflowInfo", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "PRIVSET.Run Workflows", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowMetadata": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowMetadata' resource.", "operationId": "GetWorkflowWorkflowMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.WorkflowMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workflow.WorkflowMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowMetadata.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workflow/WorkflowMetadata/{Moid}": { "get": { "tags": [ "workflow" ], "summary": "Read a 'workflow.WorkflowMetadata' resource.", "operationId": "GetWorkflowWorkflowMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workflow.WorkflowMetadata", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workflow.WorkflowMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow.WorkflowMetadata" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetWorkflowWorkflowMetadataByMoid": { "operationId": "GetWorkflowWorkflowMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workflow/WorkflowMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } } }, "components": { "schemas": { "connectorpack.ConnectorPackUpdate": { "title": "Connectorpack:Connector Pack Update", "description": "Connector Pack updates available on UCS Director.", "x-allOf-name": "connectorpack.ConnectorPackUpdate", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.ConnectorPackUpdate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.ConnectorPackUpdate" ], "default": "connectorpack.ConnectorPackUpdate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.ConnectorPackUpdate" ], "default": "connectorpack.ConnectorPackUpdate", "x-enum-as-string": true }, "CurrentVersion": { "description": "Version of connector pack currently running in UCS Director.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the connector pack.", "type": "string", "readOnly": true, "x-omitempty": true }, "NewVersion": { "description": "Version of connector pack to be installed in the next upgrade cycle.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "connectorpack.ConnectorPackUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'connectorpack.ConnectorPackUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'connectorpack.ConnectorPackUpgrade' resources.", "x-one-of-name": "connectorpack.ConnectorPackUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "connectorpack.ConnectorPackUpgrade": { "title": "Connectorpack:Connector Pack Upgrade", "description": "Used to download or install connector packs on the target device.", "x-allOf-name": "connectorpack.ConnectorPackUpgrade", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.ConnectorPackUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.ConnectorPackUpgrade" ], "default": "connectorpack.ConnectorPackUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.ConnectorPackUpgrade" ], "default": "connectorpack.ConnectorPackUpgrade", "x-enum-as-string": true }, "ConnectorPackOpType": { "description": "The type of operation to be performed on UCS Director.\n* `Install` - Installs the requisite connector packs on UCS Director.\n* `Push` - Pushes the requisite connector packs to UCS Director.", "type": "string", "enum": [ "Install", "Push" ], "default": "Install", "x-omitempty": true }, "UcsdInfo": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Workflow": { "$ref": "#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "connectorpack.ConnectorPackUpgrade.List": { "title": "List of 'connectorpack.ConnectorPackUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'connectorpack.ConnectorPackUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'connectorpack.ConnectorPackUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/connectorpack.ConnectorPackUpgrade" }, "nullable": true } } } ] }, "connectorpack.UpgradeImpact.Response": { "description": "The response body of a HTTP GET request for the 'connectorpack.UpgradeImpact' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'connectorpack.UpgradeImpact' resources.", "x-one-of-name": "connectorpack.UpgradeImpact.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/connectorpack.UpgradeImpact.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "connectorpack.UpgradeImpact": { "title": "Connectorpack:Upgrade Impact", "description": "The UpgradeImpact object is designed to assess and identify the list of connector packs to be installed or upgraded on UCS Director. It identifies the requisite connector packs for installation during the next upgrade cycle, ensuring a smooth transition and enhanced functionality.\n#### Purpose\nUpgradeImpact object plays a crucial role in planning and executing upgrades for UCS Director, ensuring that all necessary connector packs are identified and managed effectively. It evaluates eligibility for upgrades and provides insights into the upgrade readiness of UCS Director.\n#### Key Concepts\n- **Upgrade Planning:** Facilitates strategic planning for upgrades by identifying necessary connector packs and evaluating upgrade readiness.\n- **Eligibility Assessment:** Assesses UCS Director's eligibility for upgrades, ensuring that all criteria for successful upgrade execution are met.\n- **Download Management:** Manages the download status of connector packs required for upgrades, ensuring readiness for the next iteration.\n- **Relationship Management:** Establishes relationship within connector packs of a UCS Director instance to ensure accurate upgrade of connector packs.", "x-allOf-name": "connectorpack.UpgradeImpact", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connectorpack.UpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connectorpack.UpgradeImpact" ], "default": "connectorpack.UpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connectorpack.UpgradeImpact" ], "default": "connectorpack.UpgradeImpact", "x-enum-as-string": true }, "ConnectorPack": { "type": "array", "items": { "description": "Information about connector pack updates available in the next upgrade cycle.", "$ref": "#/components/schemas/connectorpack.ConnectorPackUpdate", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsEligibleForUpgrade": { "description": "States whether the UCS Director is eligible for an upgrade. Set to true if connector packs are available for upgrade, else set to false.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsUpdateDownloaded": { "description": "States whether all the requisite updates have been downloaded to the target UCS Director. Set to true if all connector packs required to upgrade UCS Director to the next iteration have been downloaded, else set to false.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "UcsdInfo": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "connectorpack.UpgradeImpact.List": { "title": "List of 'connectorpack.UpgradeImpact' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'connectorpack.UpgradeImpact' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'connectorpack.UpgradeImpact' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/connectorpack.UpgradeImpact" }, "nullable": true } } } ] }, "convergedinfra.AdapterComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.AdapterComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.AdapterComplianceDetails' resources.", "x-one-of-name": "convergedinfra.AdapterComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.AdapterComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.AdapterComplianceDetails' resource, or the expanded 'convergedinfra.AdapterComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.AdapterComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.AdapterComplianceDetails": { "title": "Convergedinfra:Adapter Compliance Details", "description": "The AdapterComplianceDetails object captures compliance details for adapters within servers of a converged infrastructure pod, focusing on hardware compatibility and firmware status. \n#### Purpose\nAdapterComplianceDetails provides essential insights into adapter compliance, assessing compatibility with standards and operational criteria necessary for seamless infrastructure operation. \n#### Key Concepts\n- **Hardware Compatibility:** Evaluates adapter compliance against hardware compatibility lists, ensuring alignment with industry standards. \n- **Firmware and Driver Information:** Includes detailed information about adapter firmware and drivers, supporting thorough compliance checks.\n- **Server Integration:** Associates adapter compliance details with server compliance data, promoting integrated compliance assessments.\n- **Administrative Control:** Accessible through defined privilege sets, ensuring secure and authorized interaction with adapter compliance information.", "x-allOf-name": "convergedinfra.AdapterComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.AdapterComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.AdapterComplianceDetails" ], "default": "convergedinfra.AdapterComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.AdapterComplianceDetails" ], "default": "convergedinfra.AdapterComplianceDetails", "x-enum-as-string": true }, "DriverName": { "description": "The driver name (e.g. nenic, nfnic) of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriverVersion": { "description": "The driver version of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The firmware version of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The HCL compatibility status for the adapter.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "HclStatusReason": { "description": "The reason for the HCL status when it is not Approved.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Adapter": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServerComplianceDetails": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.Relationship", "description": "A reference to a convergedinfraServerComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageCompliances": { "description": "An array of relationships to convergedinfraStorageComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "convergedinfra.AdapterComplianceDetails.List": { "title": "List of 'convergedinfra.AdapterComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.AdapterComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.AdapterComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.AlarmSummary": { "title": "Convergedinfra:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "convergedinfra.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.AlarmSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.AlarmSummary" ], "default": "convergedinfra.AlarmSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.AlarmSummary" ], "default": "convergedinfra.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of alarms that have severity type Critical.", "type": "integer", "format": "int64", "x-omitempty": true }, "Warning": { "description": "The count of alarms that have severity type Warning.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "convergedinfra.BaseComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.BaseComplianceDetails' resource, or the expanded 'convergedinfra.BaseComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.BaseComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.BaseComplianceDetails": { "title": "Convergedinfra:Base Compliance Details", "description": "Abstract type for all compliance details that may be part of a converged infrastructure pod.", "x-allOf-name": "convergedinfra.BaseComplianceDetails", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BaseComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.AdapterComplianceDetails", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.AdapterComplianceDetails", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails" ], "x-enum-as-string": true }, "Name": { "description": "The name of the component for which the compliance is evaluated.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for the status, when the status is Incomplete or NotApproved. Reason should help to identify the component that is not compliant.\n* `NotEvaluated` - The validation for the HCL or Interop status is yet to be performed.\n* `Missing-Os-Info` - This means the Interop status for the sever cannot be computed because we have missing OS information. Either install ucstools vib or use power shell scripts to tag proper OS information.\n* `Incompatible-Storage-Os` - The validation failed because the given storage name and version combination is not found in Interop matrix.\n* `Incompatible-Os-Info` - The validation failed because the given OS name and version combination is not found in HCL.\n* `Incompatible-Processor` - The validation failed because the given processor is not found for the given server PID in HCL.\n* `Incompatible-Server-Platform` - The validation failed because the given server platform is not found in the Interop matrix.\n* `Incompatible-Server-Model` - The validation failed because the given server model is not found in the Interop matrix.\n* `Incompatible-Adapter-Model` - The validation failed because the given adapter model is not found in the Interop matrix.\n* `Incompatible-Switch-Model` - The validation failed because the given switch model is not found in the Interop matrix.\n* `Incompatible-Server-Firmware` - The validation failed because the given server firmware version is not found in HCL.\n* `Incompatible-Switch-Firmware` - The validation failed because the given switch firmware version is not found in Interop matrix.\n* `Incompatible-Firmware` - The validation failed because the given adapter firmware version is not found in either HCL or Interop matrix.\n* `Incompatible-Driver` - The validation failed because the given driver version is not found in either HCL or Interop matrix.\n* `Incompatible-Firmware-Driver` - The validation failed because the given adapter firmware and driver version is not found in either HCL or Interop matrix.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no OS driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper OS information.\n* `Missing-Os-Or-Driver-Info` - This means the Interop status for the switch or storage array cannot be computed because we have either missing Host OS information or missing required driver information. Either install ucstools vib or use power shell scripts to tag proper OS information or install required drivers.\n* `Incompatible-Components` - The validation failed for the given server because one or more of its components failed validation.\n* `Compatible` - This means the HCL status and Interop status for the component have passed all validations for all of its related components.", "type": "string", "enum": [ "NotEvaluated", "Missing-Os-Info", "Incompatible-Storage-Os", "Incompatible-Os-Info", "Incompatible-Processor", "Incompatible-Server-Platform", "Incompatible-Server-Model", "Incompatible-Adapter-Model", "Incompatible-Switch-Model", "Incompatible-Server-Firmware", "Incompatible-Switch-Firmware", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Missing-Os-Driver-Info", "Missing-Os-Or-Driver-Info", "Incompatible-Components", "Compatible" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Compliance status for the component.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.BasePod": { "title": "Convergedinfra:Base Pod", "description": "Abstract base type for all pods.", "x-allOf-name": "convergedinfra.BasePod", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BasePod', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "Description": { "description": "Description of the pod. A short note about the nature or purpose of the pod.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the pod. Concrete pod will be created with this name.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Type": { "description": "Defines the type of the pod.\n* `FlexPod` - Pod type is FlexPod, an integrated infrastructure solution developed by Cisco and NetApp.\n* `FlashStack` - Pod type is FlashStack, an integrated infrastructure solution developed by Cisco and Pure Storage.", "type": "string", "enum": [ "FlexPod", "FlashStack" ], "default": "FlexPod", "x-omitempty": true } } } ] }, "convergedinfra.BasePodSummary": { "title": "Convergedinfra:Base Pod Summary", "description": "Summary information for the base pod. This inclues properties like number of nodes, stroage capacity/utilization, aggregated alarms for all the components of the pod etc.", "x-allOf-name": "convergedinfra.BasePodSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.BasePodSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of alarm counts for all elements of a pod based on the severity types (Critical or Warning) .", "$ref": "#/components/schemas/convergedinfra.AlarmSummary", "readOnly": true, "x-omitempty": true }, "ComplianceSummary": { "description": "The summary of compliance count status for all elements of a pod based on if the validation status (Validated/Incomplete/NotEvaluated).", "$ref": "#/components/schemas/convergedinfra.ComplianceSummary", "readOnly": true, "x-omitempty": true }, "NodeCount": { "description": "Number of nodes associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageAvailable": { "description": "The available storage capacity for this pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageCapacity": { "description": "The total storage capacity for this pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "The percentage storage utilization for this pod.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.ComplianceSummary": { "title": "Convergedinfra:Compliance Summary", "description": "The summary of compliance information based on the compliance analysis (HCL, IMT, etc.) of components.", "x-allOf-name": "convergedinfra.ComplianceSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.ComplianceSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.ComplianceSummary" ], "default": "convergedinfra.ComplianceSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.ComplianceSummary" ], "default": "convergedinfra.ComplianceSummary", "x-enum-as-string": true }, "Incomplete": { "description": "The count of elements where compliance information is not available. eg. For HCL of server, OS information is not available.", "type": "integer", "format": "int64", "x-omitempty": true }, "NotEvaluated": { "description": "The count of elements where compliance has not been evaluated. e.g. For HCL of server, status has not been evaluated due to lack of information.", "type": "integer", "format": "int64", "x-omitempty": true }, "NotListed": { "description": "The count of elements where compliance has failed for one or more reason. e.g. For HCL of server, some part of the HCL validation has failed.", "type": "integer", "format": "int64", "x-omitempty": true }, "Validated": { "description": "The count of elements where compliance has passed validation for all components. e.g. For HCL of server, all of the components have passed validation.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "convergedinfra.Pod.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.Pod' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.Pod' resources.", "x-one-of-name": "convergedinfra.Pod.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.Pod.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.Pod.Relationship": { "description": "A relationship to the 'convergedinfra.Pod' resource, or the expanded 'convergedinfra.Pod' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.Pod.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.Pod" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.Pod": { "title": "Convergedinfra:Pod", "description": "### Overview\nThe Pod object represents a unit of deployment within a converged infrastructure. It encompasses inventory details related to health, hardware compatibility (HCL), storage, nodes, and other aspects that define a pod's operational and compliance status. \n#### Purpose \nThe Pod object serves as a central entity in converged infrastructure management, offering a comprehensive view of the components and their states within a deployment. It acts as a repository of information essential for monitoring, compliance checks, and resource management. \n#### Key Concepts \n- **Deployment Unit:** A Pod is a modular deployment component, enabling scalable and efficient infrastructure management. \n- **Interoperability and Compliance:** Facilitates the assessment of the interoperability status and compliance with predefined standards, ensuring optimal operation. \n- **Resource Integration:** Integrates various resources, including servers, adapters, switches, and storage arrays, into a cohesive management structure. \n- **Privilege Management:** Access to Pod details is controlled through privilege sets, ensuring secure and authorized interactions with the infrastructure data.", "x-allOf-name": "convergedinfra.Pod", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BasePod" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.Pod', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.Pod" ], "default": "convergedinfra.Pod", "x-enum-as-string": true }, "DeploymentType": { "description": "The deployment type for this integrated system.\n* `FlexPodInfra` - The deployment type for a pod is of Infrastructure.\n* `FlexPodNG` - The deployment type for a pod is of Nextgen type.", "type": "string", "enum": [ "FlexPodInfra", "FlexPodNG" ], "default": "FlexPodInfra", "readOnly": true, "x-omitempty": true }, "InteropStatus": { "description": "The interoperability status for this solution pod.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "Summary": { "description": "The summary of pod's health, compliance, storage, number of nodes etc.", "$ref": "#/components/schemas/convergedinfra.PodSummary", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PodResourceGroup": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resource.Group.Relationship", "description": "A reference to a resourceGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServiceItemInstance": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Relationship", "description": "A reference to a workflowServiceItemInstance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.Pod.List": { "title": "List of 'convergedinfra.Pod' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.Pod' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.Pod' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.Pod" }, "nullable": true } } } ] }, "convergedinfra.PodComplianceInfo.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.PodComplianceInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.PodComplianceInfo' resources.", "x-one-of-name": "convergedinfra.PodComplianceInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.PodComplianceInfo.Relationship": { "description": "A relationship to the 'convergedinfra.PodComplianceInfo' resource, or the expanded 'convergedinfra.PodComplianceInfo' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.PodComplianceInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.PodComplianceInfo": { "title": "Convergedinfra:Pod Compliance Info", "description": "The PodComplianceInfo object captures compliance information for a converged infrastructure pod, extending the base compliance details to include specific compliance assessments for the pod itself. \n#### Purpose\nPodComplianceInfo provides a detailed view of the compliance status of a pod, highlighting areas that meet or deviate from established standards. This supports comprehensive compliance management and helps identify non-compliant components. \n#### Key Concepts\n- **Compliance Tracking:** Offers insights into the compliance status of the entire pod, facilitating proactive management and remediation. \n- **Inheritance:** Leverages the base compliance details, extending them to encompass pod-specific compliance metrics. \n- **Detailed Relationships:** Establishes connections with the pod and its components, enabling a holistic view of compliance across the infrastructure.\n- **Administrative Access:** Supports a range of privilege sets, allowing different levels of administrative interaction with compliance data.", "x-allOf-name": "convergedinfra.PodComplianceInfo", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.PodComplianceInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.PodComplianceInfo" ], "default": "convergedinfra.PodComplianceInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.PodComplianceInfo" ], "default": "convergedinfra.PodComplianceInfo", "x-enum-as-string": true }, "Details": { "description": "An array of relationships to convergedinfraBaseComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails.Relationship" }, "nullable": true, "readOnly": true }, "Pod": { "$ref": "#/components/schemas/convergedinfra.Pod.Relationship", "description": "A reference to a convergedinfraPod resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.PodComplianceInfo.List": { "title": "List of 'convergedinfra.PodComplianceInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.PodComplianceInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.PodComplianceInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo" }, "nullable": true } } } ] }, "convergedinfra.PodSummary": { "title": "Convergedinfra:Pod Summary", "description": "Summary information for the Pod, this is extenstion of properties defined in basePodSummary.", "x-allOf-name": "convergedinfra.PodSummary", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BasePodSummary" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.PodSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.PodSummary" ], "default": "convergedinfra.PodSummary", "x-enum-as-string": true }, "ActiveNodes": { "description": "Number of Nodes that are powered on and have at least 1 VM associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VmCount": { "description": "Number of VMs associated with the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "convergedinfra.ServerComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.ServerComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.ServerComplianceDetails' resources.", "x-one-of-name": "convergedinfra.ServerComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.ServerComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.ServerComplianceDetails' resource, or the expanded 'convergedinfra.ServerComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.ServerComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.ServerComplianceDetails": { "title": "Convergedinfra:Server Compliance Details", "description": "The ServerComplianceDetails object provides compliance information for servers within a converged infrastructure pod, detailing hardware compatibility and operational status. \n#### Purpose \nServerComplianceDetails is focused on evaluating server compliance, ensuring that server components meet hardware compatibility list (HCL) criteria and operational standards necessary for reliable infrastructure performance. \n#### Key Concepts\n- **HCL Compatibility:** Provides status and reasoning related to hardware compatibility, ensuring that server components are aligned with prescribed standards. \n- **Platform Information:** Encompasses detailed information about server platforms, processors, firmware, and operating systems, aiding in compliance evaluation. \n- **Integration with Pod Compliance:** Connects server compliance data with pod-level compliance insights, facilitating integrated compliance management. \n- **Read-Only Access:** Designed for secure consumption of server compliance data, ensuring consistent integration with management interfaces.", "x-allOf-name": "convergedinfra.ServerComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.ServerComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.ServerComplianceDetails" ], "default": "convergedinfra.ServerComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.ServerComplianceDetails" ], "default": "convergedinfra.ServerComplianceDetails", "x-enum-as-string": true }, "AdapterCount": { "description": "The number of ethernet NIC adapters in the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The Cisco IMC firmware version of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The HCL compatibility status of the server.\n* `NotEvaluated` - The interoperability compliance for the component has not be checked.\n* `Approved` - The component is valid as per the interoperability compliance check.\n* `NotApproved` - The component is not valid as per the interoperability compliance check.\n* `Incomplete` - The interoperability compliance check could not be completed for the component due to incomplete data.", "type": "string", "enum": [ "NotEvaluated", "Approved", "NotApproved", "Incomplete" ], "default": "NotEvaluated", "readOnly": true, "x-omitempty": true }, "HclStatusReason": { "description": "The reason for server's HCL status.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install UCS Tools VIB on the host ESXi or use OS Discovery Tool scripts to provide proper operating system information.\n* `Incompatible-Server` - The validation failed for this server because the server's model was not listed in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not listed for the given server model.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor or version was not listed in HCL for the server PID and processor combination.\n* `Incompatible-Firmware` - The validation failed because the given server firmware was not listed in the HCL for the given server PID, processor, operating system vendor and version.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has returned a service error or unrecognized result.\n* `Not-Evaluated` - This means the HclStatus for the server has not been evaluated because it is exempted.\n* `Incompatible-Components` - The validation has failed for this server because one or more components have \"Not-Listed\" status.\n* `Compatible` - The validation has passed for this server's model, processor, operating system vendor and version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Firmware", "Service-Unavailable", "Service-Error", "Not-Evaluated", "Incompatible-Components", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Os": { "description": "Details of name and version of the operating system running on the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Platform": { "description": "Details of platform of the server, examples are B-Series, C-Series, X-Series etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Processor": { "description": "The processor information of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.PhysicalSummary.Relationship", "description": "A reference to a computePhysicalSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.ServerComplianceDetails.List": { "title": "List of 'convergedinfra.ServerComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.ServerComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.ServerComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.ServerComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.StorageComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.StorageComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.StorageComplianceDetails' resources.", "x-one-of-name": "convergedinfra.StorageComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.StorageComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.StorageComplianceDetails' resource, or the expanded 'convergedinfra.StorageComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.StorageComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.StorageComplianceDetails": { "title": "Convergedinfra:Storage Compliance Details", "description": "The StorageComplianceDetails object provides compliance information for storage arrays within a converged infrastructure pod, assessing their interoperability and operational standards. \n#### Purpose\nStorageComplianceDetails focuses on evaluating storage compliance, ensuring that storage components meet interoperability criteria and operational guidelines necessary for efficient data management. \n#### Key Concepts\n- **Operating System and Protocol Evaluation:** Assesses compliance of storage arrays based on their operating systems and communication protocols. \n- **Integration with Network Components:** Evaluates storage compliance in relation to switches and adapters, promoting integrated infrastructure assessments. \n- **Pod-Level Compliance:** Connects storage compliance details with broader pod compliance information, supporting cohesive compliance management. \n- **Secure Access:** Provides controlled access to storage compliance data through privilege sets, ensuring secure and authorized interactions.", "x-allOf-name": "convergedinfra.StorageComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.StorageComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.StorageComplianceDetails" ], "default": "convergedinfra.StorageComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.StorageComplianceDetails" ], "default": "convergedinfra.StorageComplianceDetails", "x-enum-as-string": true }, "Os": { "description": "The operating system name and version (e.g. NetApp ONTAP 9.10) running on the storage array for which the compliance is getting evaluated.", "type": "string", "readOnly": true, "x-omitempty": true }, "Protocol": { "description": "The protocol configured for the communication between the switch and the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "RefDevice": { "description": "The reference device (e.g. adapter, fabric interconnect) against which the storage compliance is getting evaluated.\n* `Server` - The component type for a server in a converged infrastructure pod.\n* `Adapter` - The component type for an adapter on a server in a converged infrastructure pod.\n* `FabricInterconnect` - The component type for a fabric interconnect in a converged infrastructure pod.\n* `Nexus` - The component type for a nexus switch in a converged infrastructure pod.\n* `Storage` - The component type for a storage array in a converged infrastructure pod.", "type": "string", "enum": [ "Server", "Adapter", "FabricInterconnect", "Nexus", "Storage" ], "default": "Server", "readOnly": true, "x-omitempty": true }, "AdapterCompliance": { "$ref": "#/components/schemas/convergedinfra.AdapterComplianceDetails.Relationship", "description": "A reference to a convergedinfraAdapterComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageArray": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/storage.BaseArray.Relationship", "description": "A reference to a storageBaseArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SwitchCompliance": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.Relationship", "description": "A reference to a convergedinfraSwitchComplianceDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.StorageComplianceDetails.List": { "title": "List of 'convergedinfra.StorageComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.StorageComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.StorageComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails" }, "nullable": true } } } ] }, "convergedinfra.SwitchComplianceDetails.Response": { "description": "The response body of a HTTP GET request for the 'convergedinfra.SwitchComplianceDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'convergedinfra.SwitchComplianceDetails' resources.", "x-one-of-name": "convergedinfra.SwitchComplianceDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "convergedinfra.SwitchComplianceDetails.Relationship": { "description": "A relationship to the 'convergedinfra.SwitchComplianceDetails' resource, or the expanded 'convergedinfra.SwitchComplianceDetails' resource, or the 'null' value.", "x-one-of-name": "convergedinfra.SwitchComplianceDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "convergedinfra.SwitchComplianceDetails": { "title": "Convergedinfra:Switch Compliance Details", "description": "The SwitchComplianceDetails object captures compliance information for switches, such as Fabric Interconnects, Nexus, and MDS, within a converged infrastructure pod. \n#### Purpose \nSwitchComplianceDetails is dedicated to assessing switch compliance, ensuring that switch components meet operational and compatibility standards essential for network connectivity and performance. \n#### Key Concepts \n- **Switch Type Specifics:** Provides compliance evaluation tailored to specific switch types, including Fabric Interconnects, Nexus, and MDS. \n- **Firmware Evaluation:** Includes detailed firmware information necessary for compliance assessments and operational reliability. \n- **Pod Integration:** Links switch compliance data with pod-level compliance insights, supporting comprehensive infrastructure management. \n- **Privilege Sets:** Offers controlled access to switch compliance data, ensuring secure and authorized management interactions.", "x-allOf-name": "convergedinfra.SwitchComplianceDetails", "allOf": [ { "$ref": "#/components/schemas/convergedinfra.BaseComplianceDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'convergedinfra.SwitchComplianceDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "convergedinfra.SwitchComplianceDetails" ], "default": "convergedinfra.SwitchComplianceDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "convergedinfra.SwitchComplianceDetails" ], "default": "convergedinfra.SwitchComplianceDetails", "x-enum-as-string": true }, "Firmware": { "description": "The firmware of the switch as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model information of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of switch component. It must be set to either Fabric Interconnect, Nexus or MDS.\n* `FabricInterconnect` - The default Switch type of UCSM and IMM mode devices.\n* `NexusDevice` - Switch type of Nexus devices.\n* `MDSDevice` - Switch type of Nexus MDS devices.\n* `EdgeChassisManagementController` - Switch type of Edge Chassis Management Controller.", "type": "string", "enum": [ "FabricInterconnect", "NexusDevice", "MDSDevice", "EdgeChassisManagementController" ], "default": "FabricInterconnect", "readOnly": true, "x-omitempty": true }, "PodCompliance": { "$ref": "#/components/schemas/convergedinfra.PodComplianceInfo.Relationship", "description": "A reference to a convergedinfraPodComplianceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageCompliances": { "description": "An array of relationships to convergedinfraStorageComplianceDetails resources.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.StorageComplianceDetails.Relationship" }, "nullable": true, "readOnly": true }, "Switch": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.ElementSummary.Relationship", "description": "A reference to a networkElementSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "convergedinfra.SwitchComplianceDetails.List": { "title": "List of 'convergedinfra.SwitchComplianceDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'convergedinfra.SwitchComplianceDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'convergedinfra.SwitchComplianceDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/convergedinfra.SwitchComplianceDetails" }, "nullable": true } } } ] }, "iaas.ConnectorPack.Response": { "description": "The response body of a HTTP GET request for the 'iaas.ConnectorPack' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.ConnectorPack' resources.", "x-one-of-name": "iaas.ConnectorPack.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.ConnectorPack.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.ConnectorPack.Relationship": { "description": "A relationship to the 'iaas.ConnectorPack' resource, or the expanded 'iaas.ConnectorPack' resource, or the 'null' value.", "x-one-of-name": "iaas.ConnectorPack.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.ConnectorPack" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.ConnectorPack": { "title": "Iaas:Connector Pack", "description": "The ConnectorPack object is essential for managing connector pack versions within UCS Director (UCSD), facilitating configuration and dependency management. \n#### Purpose \nConnectorPack documents the versions and states of connector packs, supporting efficient management and deployment of connectors in UCSD. \n#### Key Concepts \n- **Version Management:** Tracks connector pack versions, ensuring compatibility and optimal performance. \n- **Dependency Tracking:** Monitors dependencies, aiding in configuration management and deployment strategies. \n- **Read-Only Access:** Ensures connector pack information is available for review without alteration.", "x-allOf-name": "iaas.ConnectorPack", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.ConnectorPack', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.ConnectorPack" ], "default": "iaas.ConnectorPack", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.ConnectorPack" ], "default": "iaas.ConnectorPack", "x-enum-as-string": true }, "CompleteVersion": { "description": "Complete version of the connector pack including build number.", "type": "string", "readOnly": true, "x-omitempty": true }, "DependencyNames": { "type": "array", "items": { "description": "List of dependent connectors on the UCSD for this connector. For example BigData depends on UCS Connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownloadedVersion": { "description": "Version of the connector pack that is last downloaded successfully to UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the connector pack running on the UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State of the connector pack whether it is enabled or disabled.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Version of the connector pack.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.ConnectorPack.List": { "title": "List of 'iaas.ConnectorPack' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.ConnectorPack' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.ConnectorPack' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ConnectorPack" }, "nullable": true } } } ] }, "iaas.CustomTaskInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.CustomTaskInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.CustomTaskInfo' resources.", "x-one-of-name": "iaas.CustomTaskInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.CustomTaskInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.CustomTaskInfo.Relationship": { "description": "A relationship to the 'iaas.CustomTaskInfo' resource, or the expanded 'iaas.CustomTaskInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.CustomTaskInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.CustomTaskInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.CustomTaskInfo": { "title": "Iaas:Custom Task Info", "description": "The CustomTaskInfo object offers insights into the execution of custom tasks within UCS Director (UCSD), supporting workflow customization and management. \n#### Purpose \nCustomTaskInfo documents execution details of custom tasks, aiding in workflow personalization and optimization. \n#### Key Concepts \n- **Custom Task Execution:** Tracks execution of custom tasks, supporting process customization and refinement. \n- **Read-Only Access:** Ensures secure access to custom task data without alteration.", "x-allOf-name": "iaas.CustomTaskInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.CustomTaskInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.CustomTaskInfo" ], "default": "iaas.CustomTaskInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.CustomTaskInfo" ], "default": "iaas.CustomTaskInfo", "x-enum-as-string": true }, "TaskDescription": { "description": "Task decription or Comment of the Custom task.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskLabel": { "description": "Task Label in the Workflow.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Name of the Custom Task in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.CustomTaskInfo.List": { "title": "List of 'iaas.CustomTaskInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.CustomTaskInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.CustomTaskInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.CustomTaskInfo" }, "nullable": true } } } ] }, "iaas.DeviceStatus.Response": { "description": "The response body of a HTTP GET request for the 'iaas.DeviceStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.DeviceStatus' resources.", "x-one-of-name": "iaas.DeviceStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.DeviceStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.DeviceStatus.Relationship": { "description": "A relationship to the 'iaas.DeviceStatus' resource, or the expanded 'iaas.DeviceStatus' resource, or the 'null' value.", "x-one-of-name": "iaas.DeviceStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.DeviceStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.DeviceStatus": { "title": "Iaas:Device Status", "description": "The DeviceStatus object is pivotal in managing infrastructure accounts within UCS Director (UCSD), offering insights into connection status and device details. It aids in maintaining connectivity and operational integrity. \n#### Purpose \nDeviceStatus provides detailed information about infrastructure accounts managed by UCSD, supporting connection monitoring and device management. \n#### Key Concepts \n- **Connection Monitoring:** Tracks connection status between UCSD and managed devices, ensuring operational reliability. \n- **Device Insights:** Offers comprehensive details about device vendors, models, and versions, aiding in effective management. \n- **Read-Only Access:** Ensures secure access to device information without modification.", "x-allOf-name": "iaas.DeviceStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.DeviceStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.DeviceStatus" ], "default": "iaas.DeviceStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.DeviceStatus" ], "default": "iaas.DeviceStatus", "x-enum-as-string": true }, "AccountName": { "description": "The UCSD infra account name. Account Name is created when UCSD admin adds any new infra account (Physical/Virtual/Compute/Network) to be managed by UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountType": { "description": "The UCSD Infra Account type.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "description": "The UCSD Infra Account category.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimStatus": { "description": "Describes if the device is claimed in Intersight or not.\n* `Unknown` - If UCS Director managed account claim status information is unknown.\n* `Yes` - If UCS Director managed account is claimed in Intersight.\n* `No` - If UCS Director managed account is not claimed in Intersight.\n* `Not Applicable` - If UCS Director managed account is not capable of providing claim status information.", "type": "string", "enum": [ "Unknown", "Yes", "No", "Not Applicable" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Describes about the connection status between the UCSD and the actual end device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceModel": { "description": "Describes about the device model.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceVendor": { "description": "Describes about the device vendor/manufacturer of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceVersion": { "description": "Describes about the current firmware version running on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "The IPAddress of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pod": { "description": "Describes about the pod to which this device belongs to in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodType": { "description": "Describes about the podType of Pod to which this device belongs to in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.DeviceStatus.List": { "title": "List of 'iaas.DeviceStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.DeviceStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.DeviceStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DeviceStatus" }, "nullable": true } } } ] }, "iaas.DiagnosticMessages.Response": { "description": "The response body of a HTTP GET request for the 'iaas.DiagnosticMessages' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.DiagnosticMessages' resources.", "x-one-of-name": "iaas.DiagnosticMessages.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.DiagnosticMessages.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.DiagnosticMessages": { "title": "Iaas:Diagnostic Messages", "description": "The DiagnosticMessages object is vital for capturing diagnostic alerts and messages within UCS Director (UCSD), aiding in system health monitoring and issue resolution. \n#### Purpose\nDiagnosticMessages document alerts and recommendations, supporting proactive system management and troubleshooting. \n#### Key Concepts \n- **Alert Tracking:** Records diagnostic alerts, aiding in system health assessment and management. \n- **Recommendation Documentation:** Provides actionable recommendations for alert resolution, supporting efficient troubleshooting. \n- **Read-Only Access:** Ensures secure access to diagnostic data without alteration.", "x-allOf-name": "iaas.DiagnosticMessages", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.DiagnosticMessages', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.DiagnosticMessages" ], "default": "iaas.DiagnosticMessages", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.DiagnosticMessages" ], "default": "iaas.DiagnosticMessages", "x-enum-as-string": true }, "Category": { "description": "Message category of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "description": "Unique ID of UCS Director getting registerd with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "Item": { "description": "Message target type of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastChecked": { "description": "Last checked time of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Detailed info about the alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "Recommendation": { "description": "Recommended fix for the alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the given alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusId": { "description": "Status Id of the given alert.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.DiagnosticMessages.List": { "title": "List of 'iaas.DiagnosticMessages' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.DiagnosticMessages' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.DiagnosticMessages' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DiagnosticMessages" }, "nullable": true } } } ] }, "iaas.LicenseInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.LicenseInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.LicenseInfo' resources.", "x-one-of-name": "iaas.LicenseInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.LicenseInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.LicenseInfo.Relationship": { "description": "A relationship to the 'iaas.LicenseInfo' resource, or the expanded 'iaas.LicenseInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.LicenseInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.LicenseInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.LicenseInfo": { "title": "Iaas:License Info", "description": "The LicenseInfo object is a fundamental component in managing license details within UCS Director (UCSD), providing a structured overview of license types and expiration dates. \n#### Purpose \nLicenseInfo offers comprehensive data about licenses in UCSD, supporting proactive license management and compliance. \n#### Key Concepts \n- **Type and Expiration:** Captures license type and expiration details, aiding in strategic license management. \n- **Utilization Overview:** Provides insights into license utilization, supporting optimization and planning. \n- **Read-Only Access:** Ensures secure access to license data without modification.", "x-allOf-name": "iaas.LicenseInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseInfo" ], "default": "iaas.LicenseInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseInfo" ], "default": "iaas.LicenseInfo", "x-enum-as-string": true }, "LicenseExpirationDate": { "description": "UCS Director license expiration date.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseKeysInfo": { "type": "array", "items": { "description": "License keys info for UCSD.", "$ref": "#/components/schemas/iaas.LicenseKeysInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LicenseType": { "description": "License type of UCSD whether it is EVAL/Permanent/Subscription..", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseUtilizationInfo": { "type": "array", "items": { "description": "List of license utilization info for UCSD.", "$ref": "#/components/schemas/iaas.LicenseUtilizationInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.LicenseInfo.List": { "title": "List of 'iaas.LicenseInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.LicenseInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.LicenseInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.LicenseInfo" }, "nullable": true } } } ] }, "iaas.LicenseKeysInfo": { "title": "Iaas:License Keys Info", "description": "### Overview\nThe LicenseKeysInfo object serves as an essential element in managing license details within UCS Director. It encapsulates information about unique license identifiers and expiration dates, facilitating effective license management and renewal strategies. \n#### Purpose \nLicenseKeysInfo provides detailed information about the identification and validity of licenses, supporting proactive management and ensuring continuity of service. \n#### Key Concepts \n- **Unique Identification:** - Each license is uniquely identified, enabling precise tracking and management. \n- **Expiration Management:** - Offers insights into license expiration, assisting in timely renewals and preventing service disruptions. \n- **Read-Only Access:** - Designed for secure access to license information without alteration.", "x-allOf-name": "iaas.LicenseKeysInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseKeysInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseKeysInfo" ], "default": "iaas.LicenseKeysInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseKeysInfo" ], "default": "iaas.LicenseKeysInfo", "x-enum-as-string": true }, "Count": { "description": "Number of licenses available for the UCSD PID (Product ID).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExpirationDate": { "description": "Expiration date for the license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseId": { "description": "UCS Director Unique license ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "PID (Product ID) for UCSD License.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iaas.LicenseUtilizationInfo": { "title": "Iaas:License Utilization Info", "description": "### Overview\nThe LicenseUtilizationInfo object is crucial for managing and understanding the utilization of licenses within the UCS Director (UCSD). This provides a comprehensive view of license details and their actual usage, enabling efficient resource management and planning. \n#### Purpose \nThe LicenseUtilizationInfo object helps administrators track and optimize the use of licenses associated with various features in UCSD. It ensures that license limits are adhered to while providing insights into actual usage patterns. \n#### Key Concepts \n- **License Tracking:** - Offers a clear view of the licenses available and used within the system, aiding compliance and optimization. \n- **Usage Insights:** - Provides actionable data on how licenses are being utilized, supporting informed decision-making for resource allocation. \n- **Read-Only Access:** - Ensures that the information is accessible for review without modification, maintaining integrity and compliance.", "x-allOf-name": "iaas.LicenseUtilizationInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.LicenseUtilizationInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.LicenseUtilizationInfo" ], "default": "iaas.LicenseUtilizationInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.LicenseUtilizationInfo" ], "default": "iaas.LicenseUtilizationInfo", "x-enum-as-string": true }, "ActualUsed": { "description": "Number of licenses actually used for this feature.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Label": { "description": "License label of UCSD license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicensedLimit": { "description": "License limit for this license feature.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "SKU for the UCSD license.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iaas.MostRunTasks.Response": { "description": "The response body of a HTTP GET request for the 'iaas.MostRunTasks' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.MostRunTasks' resources.", "x-one-of-name": "iaas.MostRunTasks.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.MostRunTasks.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.MostRunTasks.Relationship": { "description": "A relationship to the 'iaas.MostRunTasks' resource, or the expanded 'iaas.MostRunTasks' resource, or the 'null' value.", "x-one-of-name": "iaas.MostRunTasks.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.MostRunTasks" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.MostRunTasks": { "title": "Iaas:Most Run Tasks", "description": "The MostRunTasks object provides insights into frequently executed workflow tasks within UCS Director (UCSD). \n#### Purpose \nMostRunTasks captures data about task execution frequency, aiding in workflow analysis and improvement strategies. \n#### Key Concepts \n- **Execution Frequency:** Tracks how often tasks are executed, supporting process refinement and optimization. \n- **Read-Only Access:** Ensures secure access to task data without modification.", "x-allOf-name": "iaas.MostRunTasks", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.MostRunTasks', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.MostRunTasks" ], "default": "iaas.MostRunTasks", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.MostRunTasks" ], "default": "iaas.MostRunTasks", "x-enum-as-string": true }, "TaskCategory": { "description": "A functional area to which a task belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Name of the task executed in UCSD.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskType": { "description": "Type of the task whether it is system task or custom task.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.MostRunTasks.List": { "title": "List of 'iaas.MostRunTasks' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.MostRunTasks' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.MostRunTasks' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.MostRunTasks" }, "nullable": true } } } ] }, "iaas.ServiceRequest.Response": { "description": "The response body of a HTTP GET request for the 'iaas.ServiceRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.ServiceRequest' resources.", "x-one-of-name": "iaas.ServiceRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.ServiceRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.ServiceRequest": { "title": "Iaas:Service Request", "description": "The ServiceRequest object is integral to managing service requests within UCS Director (UCSD), capturing essential details about service request and statuses request workflows .\n#### Purpose \nServiceRequest documents and tracks service requests, supporting efficient process management and resolution strategies. \n#### Key Concepts \n- **Workflow Documentation:** Captures information about workflow steps executed in service requests, aiding process refinement. \n- **Status Tracking:** Monitors request statuses, supporting timely resolution and management. \n- **Read-Only Access:** Ensures secure access to service request data without modification.", "x-allOf-name": "iaas.ServiceRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.ServiceRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.ServiceRequest" ], "default": "iaas.ServiceRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.ServiceRequest" ], "default": "iaas.ServiceRequest", "x-enum-as-string": true }, "Duration": { "description": "Service request duration.", "type": "string", "readOnly": true, "x-omitempty": true }, "InitiatingUser": { "description": "Service Request initiating user.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestEndTime": { "description": "Service request end time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestId": { "description": "Service request id of an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestStartTime": { "description": "Service request start time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestType": { "description": "Service request type of an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "UCSD service request status.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowName": { "description": "Executed workflow name for an SR.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowSteps": { "type": "array", "items": { "description": "Step details of Service Request.", "$ref": "#/components/schemas/iaas.WorkflowSteps", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.ServiceRequest.List": { "title": "List of 'iaas.ServiceRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.ServiceRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.ServiceRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ServiceRequest" }, "nullable": true } } } ] }, "iaas.SystemTaskInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.SystemTaskInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.SystemTaskInfo' resources.", "x-one-of-name": "iaas.SystemTaskInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.SystemTaskInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.SystemTaskInfo.Relationship": { "description": "A relationship to the 'iaas.SystemTaskInfo' resource, or the expanded 'iaas.SystemTaskInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.SystemTaskInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.SystemTaskInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.SystemTaskInfo": { "title": "Iaas:System Task Info", "description": "The SystemTaskInfo object provides details about library task executions within UCS Director (UCSD), supporting system oversight and process management. \n#### Purpose\nSystemTaskInfo documents task execution data, aiding in workflow task management and optimization strategies. \n#### Key Concepts \n- **Execution Frequency:** Tracks each library tasks execution count, supporting process refinement and optimization.\n- **Functional Categorization:** Provides information regarding the task category to which the library task belongs in UCSD. \n- **Read-Only Access:** Ensures secure access to system task data without modification.", "x-allOf-name": "iaas.SystemTaskInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.SystemTaskInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.SystemTaskInfo" ], "default": "iaas.SystemTaskInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.SystemTaskInfo" ], "default": "iaas.SystemTaskInfo", "x-enum-as-string": true }, "TaskCategory": { "description": "A functional area to which a task belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskExecutionCount": { "description": "Number of times this task has been executed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "Task name of the UCSD Task.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.SystemTaskInfo.List": { "title": "List of 'iaas.SystemTaskInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.SystemTaskInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.SystemTaskInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.SystemTaskInfo" }, "nullable": true } } } ] }, "iaas.UcsdInfo.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdInfo' resources.", "x-one-of-name": "iaas.UcsdInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdInfo.Relationship": { "description": "A relationship to the 'iaas.UcsdInfo' resource, or the expanded 'iaas.UcsdInfo' resource, or the 'null' value.", "x-one-of-name": "iaas.UcsdInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.UcsdInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.UcsdInfo": { "title": "Iaas:Ucsd Info", "description": "The UcsdInfo object is a central component in managing UCS Director accounts, offering insights into system configurations and connection status. It facilitates comprehensive management and monitoring of UCSD environments.\n#### Purpose\nUcsdInfo provides a detailed overview of UCS Director instances supporting effective system administration and status evaluation.\n#### Key Concepts\n- **Comprehensive Management:** Captures vital information about UCSD configurations and accounts, aiding efficient system oversight. \n- **Status Evaluation:** Monitors the operational state of UCSD, assisting in maintaining system health and performance. \n- **Access Control:** Supports privilege-based access to ensure secure and authorized system management.", "x-allOf-name": "iaas.UcsdInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdInfo" ], "default": "iaas.UcsdInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdInfo" ], "default": "iaas.UcsdInfo", "x-enum-as-string": true }, "DeviceId": { "description": "Moid of the UCS Director device connector's asset.DeviceRegistration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Guid": { "description": "Unique ID of UCS Director getting registerd with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "The UCS Director hostname for management.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ip": { "description": "The UCS Director IP address for management.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastBackup": { "description": "Last successful backup created for this UCS Director appliance if backup is configured.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "NodeType specifies if UCS Director is deployed in Stand-alone or Multi Node.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductName": { "description": "The UCS Director product name.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductVendor": { "description": "The UCS Director product vendor.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductVersion": { "description": "The UCS Director product/platform version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The UCS Director status. Possible values are Active, Inactive, Unknown.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectorPack": { "description": "An array of relationships to iaasConnectorPack resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.ConnectorPack.Relationship" }, "nullable": true, "readOnly": true }, "CustomTaskInfo": { "description": "An array of relationships to iaasCustomTaskInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.CustomTaskInfo.Relationship" }, "nullable": true, "readOnly": true }, "DeviceStatus": { "description": "An array of relationships to iaasDeviceStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.DeviceStatus.Relationship" }, "nullable": true, "readOnly": true }, "LicenseInfo": { "$ref": "#/components/schemas/iaas.LicenseInfo.Relationship", "description": "A reference to a iaasLicenseInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MostRunTasks": { "description": "An array of relationships to iaasMostRunTasks resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.MostRunTasks.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SystemTaskInfo": { "description": "An array of relationships to iaasSystemTaskInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.SystemTaskInfo.Relationship" }, "nullable": true, "readOnly": true }, "UcsdManagedInfra": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.Relationship", "description": "A reference to a iaasUcsdManagedInfra resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdInfo.List": { "title": "List of 'iaas.UcsdInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdInfo" }, "nullable": true } } } ] }, "iaas.UcsdManagedInfra.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdManagedInfra' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdManagedInfra' resources.", "x-one-of-name": "iaas.UcsdManagedInfra.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdManagedInfra.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdManagedInfra.Relationship": { "description": "A relationship to the 'iaas.UcsdManagedInfra' resource, or the expanded 'iaas.UcsdManagedInfra' resource, or the 'null' value.", "x-one-of-name": "iaas.UcsdManagedInfra.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" } ], "discriminator": { "propertyName": "ClassId" } }, "iaas.UcsdManagedInfra": { "title": "Iaas:Ucsd Managed Infra", "description": "The UcsdManagedInfra object is critical for overseeing UCS Director (UCSD) managed infrastructure, providing statistics and insights into managed resources.\n#### Purpose\nUcsdManagedInfra offers a detailed view of infrastructure components managed by UCSD, supporting effective resource management and planning.\n#### Key Concepts\n- **Infrastructure Statistics:** Captures data on infrastructure components like hosts and virtual machines, aiding in system oversight. \n- **Resource Management:** Provides insights into user accounts and groups, supporting efficient resource allocation. \n- **Read-Only Access:** Ensures infrastructure data is available for review without modification.", "x-allOf-name": "iaas.UcsdManagedInfra", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdManagedInfra', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdManagedInfra" ], "default": "iaas.UcsdManagedInfra", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdManagedInfra" ], "default": "iaas.UcsdManagedInfra", "x-enum-as-string": true }, "AdvancedCatalogCount": { "description": "Total advanced catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "BmCatalogCount": { "description": "Total bare metal catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ContainerCatalogCount": { "description": "Total service container catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EsxiHostCount": { "description": "Total ESXi hosts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalGroupCount": { "description": "Total external (Ldap) groups in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HypervHostCount": { "description": "Total HyperV hosts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LocalGroupCount": { "description": "Total local groups in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StandardCatalogCount": { "description": "Total standard catalogs in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UserCount": { "description": "Total user accounts in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VdcCount": { "description": "Total virtual datacenters in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VmCount": { "description": "Total Virtual machines in UCSD.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Guid": { "$ref": "#/components/schemas/iaas.UcsdInfo.Relationship", "description": "A reference to a iaasUcsdInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdManagedInfra.List": { "title": "List of 'iaas.UcsdManagedInfra' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdManagedInfra' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdManagedInfra' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdManagedInfra" }, "nullable": true } } } ] }, "iaas.UcsdMessages.Response": { "description": "The response body of a HTTP GET request for the 'iaas.UcsdMessages' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iaas.UcsdMessages' resources.", "x-one-of-name": "iaas.UcsdMessages.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iaas.UcsdMessages.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iaas.UcsdMessages": { "title": "Iaas:Ucsd Messages", "description": "The UcsdMessages object captures messages from UCS Director (UCSD), supporting system communication and alert management. \n#### Purpose\nUcsdMessages document system messages, aiding in communication and issue resolution within UCSD. \n####Key Concepts \n- **Message Documentation:** Records system messages, supporting communication and alert tracking.\n- **Alert Integration:** Integrates message alerts within the system, supporting proactive management and resolution. \n- **Read-Only Access:** Ensures secure access to message data without modification.", "x-allOf-name": "iaas.UcsdMessages", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.UcsdMessages', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.UcsdMessages" ], "default": "iaas.UcsdMessages", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.UcsdMessages" ], "default": "iaas.UcsdMessages", "x-enum-as-string": true }, "StatusId": { "description": "Last checked time of the alerts.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iaas.UcsdMessages.List": { "title": "List of 'iaas.UcsdMessages' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iaas.UcsdMessages' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iaas.UcsdMessages' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iaas.UcsdMessages" }, "nullable": true } } } ] }, "iaas.WorkflowSteps": { "title": "Iaas:Workflow Steps", "description": "### Overview\nThe WorkflowSteps object is integral to managing workflow operations within UCS Director (UCSD), capturing the step-by-step progression of service requests. This provides structured information about each workflow step, facilitating process monitoring and optimization. \n#### Purpose \nWorkflowSteps help in documenting and analyzing the workflow stages in UCSD service requests, enabling better tracking and refinement of operational processes. \n#### Key Concepts \n- **Process Documentation:** - Records detailed information about each step in a workflow, supporting transparency and traceability. \n- **Status Monitoring:** - Provides status updates for workflow steps, aiding in real-time process management. \n- **Read-Only Access:** - Ensures workflow details are available for review without modification.", "x-allOf-name": "iaas.WorkflowSteps", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iaas.WorkflowSteps', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iaas.WorkflowSteps" ], "default": "iaas.WorkflowSteps", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iaas.WorkflowSteps" ], "default": "iaas.WorkflowSteps", "x-enum-as-string": true }, "CompletedTime": { "description": "Completed time of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "Status message of the workflow step.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsd.BackupInfo.Response": { "description": "The response body of a HTTP GET request for the 'ucsd.BackupInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ucsd.BackupInfo' resources.", "x-one-of-name": "ucsd.BackupInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ucsd.BackupInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ucsd.BackupInfo": { "title": "Ucsd:Backup Info", "description": "The BackupInfo object provides detailed insights into backup images available for restoration on target endpoint (UCS Director) devices. It captures essential metadata and status information to support recovery operations.\n#### Purpose\nThe BackupInfo object provides comprehensive visibility into available backup images and real-time status updates on backup progress. It ensures that restoration processes rely on accurate, current data, enabling informed and efficient recovery operations.\n#### Key Concepts\n- **Transparency:** Delivers comprehensive metadata about backup images, including status, location, and completion percentage.\n- **Access Control:** Designed to allow authorized personnel to access backup information securely.\n- **Relationship Management:** Extends abstract backup information concepts to provide a detailed view of available resources.", "x-allOf-name": "ucsd.BackupInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/recovery.AbstractBackupInfo" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.BackupInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-as-string": true }, "BackupFileName": { "description": "Auto generated backup file name with user defined prefix and timestamp.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupLocation": { "description": "Backup location for restore operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupServerIp": { "description": "Backup server for storing backup images.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupSize": { "description": "Backup image size in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Connectors": { "type": "array", "items": { "description": "Connector pack versions active on UCS Director at the time of backup.", "$ref": "#/components/schemas/ucsd.ConnectorPack", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Duration": { "description": "Time taken to complete the backup.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EncryptionKey": { "description": "Encryption key for backup file.", "type": "string", "writeOnly": true, "x-omitempty": true }, "FailureReason": { "description": "The cause of the backup failure.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPurged": { "description": "Backup image purge status based on retention policy.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LastModified": { "description": "Backup record last modified time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PercentageCompletion": { "description": "Backup completion percentage status.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ProductVersion": { "description": "End device product version at the backup time.", "type": "string", "x-omitempty": true }, "Protocol": { "description": "Supported remote backup protocol (FTP, SCP and SFTP); not applicable for localhost (127.0.0.1).", "type": "string", "readOnly": true, "x-omitempty": true }, "StageCompletion": { "description": "Backup status stage information.", "type": "string", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Backup initiation start time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The current backup status.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsd.BackupInfo.List": { "title": "List of 'ucsd.BackupInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ucsd.BackupInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ucsd.BackupInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ucsd.BackupInfo" }, "nullable": true } } } ] }, "ucsd.ConnectorPack": { "title": "Ucsd:Connector Pack", "description": "Connector pack details from the backup file.", "x-allOf-name": "ucsd.ConnectorPack", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.ConnectorPack', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.ConnectorPack" ], "default": "ucsd.ConnectorPack", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.ConnectorPack" ], "default": "ucsd.ConnectorPack", "x-enum-as-string": true }, "ConnectorFeature": { "description": "State of connector pack (enabled/ disabled).", "type": "string", "readOnly": true, "x-omitempty": true }, "DependencyNames": { "type": "array", "items": { "description": "List of dependent connectors on UCS Director (e.g., BigData depends on UCS Connector).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownloadedVersion": { "description": "Last successfully downloaded connector pack version successfully for UCS Director.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "UCS Director connector pack name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "List of dependent connectors on UCS Director (e.g., BigData depends on UCS Connector).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "State": { "description": "Connector pack state (enabled/disabled).", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The connector pack version.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsd.UcsdRestoreParameters": { "title": "Ucsd:Ucsd Restore Parameters", "description": "UCS director restore workflow configuration parameters.", "x-allOf-name": "ucsd.UcsdRestoreParameters", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/recovery.ConfigParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsd.UcsdRestoreParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsd.UcsdRestoreParameters" ], "default": "ucsd.UcsdRestoreParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsd.UcsdRestoreParameters" ], "default": "ucsd.UcsdRestoreParameters", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Location": { "description": "Full server path location in format - hostname-or-ipv4address<:port>/absolute-file-path.", "type": "string", "x-omitempty": true }, "Password": { "description": "Target backup server password for SFTP or SCP access.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Protocol": { "description": "Backup protocol for UCS Director.", "type": "string", "x-omitempty": true }, "RestoreConfigurationFiles": { "description": "Decision on UCS Director property files restoration.", "type": "boolean", "x-omitempty": true }, "RestoreLicense": { "description": "Decision on license restoration.", "type": "boolean", "x-omitempty": true }, "Username": { "description": "Target backup server user name for SFTP or SCP access.", "type": "string", "x-omitempty": true } } } ] }, "workflow.AbstractLoopTask": { "title": "Workflow:Abstract Loop Task", "description": "An abstract loop task which is used to model different types of loops like serial and parallel.", "x-allOf-name": "workflow.AbstractLoopTask", "allOf": [ { "$ref": "#/components/schemas/workflow.ControlTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AbstractLoopTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.LoopTask", "workflow.SerialLoopTask" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.LoopTask", "workflow.SerialLoopTask" ], "x-enum-as-string": true }, "Count": { "description": "Count value for the loop, this can be a static value defined as a constant at design time or can be a dynamic value defined as an expression that will evaluate to an integer value at execution time. Dynamic values for count must be specified as a template. For example, if a loop must run for a count which matches the length of a workflow input called StringArray, then the count must be specified using a template '{{ len .global.workflow.input.StringArray }}'. The count must be less than or equal to 100. If count is given as a dynamic value, and during execution time if count evaluates to be a value greater than 100, then the loop task will fail.", "type": "string", "x-omitempty": true }, "LoopStartTask": { "description": "Start task where the list of tasks will be executed multiple times based on the count or condition value.", "type": "string", "x-omitempty": true }, "OnFailure": { "description": "This specifies the name of the next task to run if all iterations of the loop task do not succeed. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "OnSuccess": { "description": "This specifies the name of the next task to run if all iterations of the loop task succeeds. The unique name given to the task instance within the workflow must be provided here. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true } } } ] }, "workflow.AbstractResourceSelector": { "title": "Workflow:Abstract Resource Selector", "description": "The abstract selector which can be used to create selection criteria for inputs.", "x-allOf-name": "workflow.AbstractResourceSelector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.AbstractWorkerTask": { "title": "Workflow:Abstract Worker Task", "description": "An AbstractWorkerTask is used to model a task that does some end-user work. This can be another task or it can be another workflow.", "x-allOf-name": "workflow.AbstractWorkerTask", "allOf": [ { "$ref": "#/components/schemas/workflow.WorkflowTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AbstractWorkerTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.SubWorkflowTask", "workflow.WaitTask", "workflow.WorkerTask" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.SubWorkflowTask", "workflow.WaitTask", "workflow.WorkerTask" ], "x-enum-as-string": true }, "InputParameters": { "description": "JSON formatted key-value pairs that define the inputs given to the task. Mapping for task inputs can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as '${Source.< input | output | variable>.}'. 'Source' can be either workflow or the name of an earlier task within the workflow. You can map the task input to either a workflow input, a task output or a variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \"InputParameters\":{ \"input1\":\"${workflow.variable.var1}\", \"input2\":\"prefixStr_{{.global.workflow.input.input1}}\" } where task input1 is mapped directly to variable var1 and task input2 is using a template to prefix a string to workflow input1 and then assign that value.", "x-omitempty": true }, "OnFailure": { "description": "This specifies the name of the next task to run if Task fails. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "OnSuccess": { "description": "This specifies the name of the next task to run if Task succeeds. This is the unique name given to the task instance within the workflow. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "RollbackDisabled": { "description": "The task is disabled/enabled for rollback operation in this workflow if the task has rollback support.", "type": "boolean", "default": false, "x-omitempty": true }, "VariableParameters": { "description": "JSON formatted key-value pairs that perform variable update at the end of the task execution. Mapping for variables can be provided as either static values, direct mapping or advanced mapping using templates. The direct mapping can be specified as '${Source.< input | output | variable>.}'. 'Source' can be either workflow or the name of the current or an earlier task within the workflow. You can map the variable to either a workflow input, a task output or another variable. Golang template syntax is supported for advanced mapping. A simple flattened example is \"VariableParameters\":{ \"var1\":\"${task1.output.output1}\", \"var2\":\"{{ Itoa .global.workflow.variable.varInt}}\" } where variable var1 is mapped directly to output1 of task1 and variable var2 is using a template to convert another variable varInt to string and assign that value.", "x-omitempty": true } } } ] }, "workflow.AnsibleBatchExecutor.Response": { "description": "The response body of a HTTP GET request for the 'workflow.AnsibleBatchExecutor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.AnsibleBatchExecutor' resources.", "x-one-of-name": "workflow.AnsibleBatchExecutor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.AnsibleBatchExecutor": { "title": "Ansible Batch Executor", "description": "The AnsibleBatchExecutor object is a core component within Intersight's workflow framework, designed to facilitate the execution of Ansible commands in batch mode. By leveraging SSH requests, this object enables the execution of a series of Ansible playbooks as part of a single task, enhancing efficiency and automation capabilities.\n#### Purpose\nThe AnsibleBatchExecutor streamlines task execution by associating multiple Ansible commands with SSH requests, allowing for comprehensive task management within a unified framework. It integrates seamlessly with existing systems to support complex task orchestration.\n#### Key Concepts\n- **Batch Processing:** Allows multiple Ansible commands to be executed in a batch, reducing overhead and improving performance.\n- **Ansible Session:** Supports Ansible sessions, and in each session, a single Ansible playbook can be executed on the Ansible Control Node.", "x-allOf-name": "workflow.AnsibleBatchExecutor", "allOf": [ { "$ref": "#/components/schemas/workflow.BatchExecutor" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AnsibleBatchExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AnsibleBatchExecutor" ], "default": "workflow.AnsibleBatchExecutor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AnsibleBatchExecutor" ], "default": "workflow.AnsibleBatchExecutor", "x-enum-as-string": true }, "TaskDefinition": { "$ref": "#/components/schemas/workflow.TaskDefinition.Relationship", "description": "A reference to a workflowTaskDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.AnsibleBatchExecutor.List": { "title": "List of 'workflow.AnsibleBatchExecutor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.AnsibleBatchExecutor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.AnsibleBatchExecutor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.AnsibleBatchExecutor" }, "nullable": true } } } ] }, "workflow.AnsiblePlaySession": { "title": "Ansible Play Session", "description": "This models a single Ansible playbook execution session on the Ansible Control node. While execution of the respective Ansible task, the below provided property values are used to construct the SSH Batch executor, which gets executed on the endpoint.", "x-allOf-name": "workflow.AnsiblePlaySession", "allOf": [ { "$ref": "#/components/schemas/workflow.Api" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AnsiblePlaySession', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AnsiblePlaySession" ], "default": "workflow.AnsiblePlaySession", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AnsiblePlaySession" ], "default": "workflow.AnsiblePlaySession", "x-enum-as-string": true }, "CommandLineArguments": { "description": "The command line arguments for running the Ansible playbook against the given endpoint. Escape character backslash needs to be used when the command line arguments contain double quotes in them.", "type": "string", "x-omitempty": true }, "HostInventory": { "description": "The path of the host inventory file that resides on the Ansible Endpoint target or the comma separated list of hosts on which the Ansible playbook is to be run. Make sure to suffix a comma when the list of hosts is provided as input, even if the list has only one value.", "type": "string", "x-omitempty": true }, "PlaybookPath": { "description": "The path of the Ansible playbook that resides on the Ansible Endpoint target.", "type": "string", "x-omitempty": true }, "SshOpTimeout": { "description": "SSH operation timeout value in seconds. Value provided should be string representation of an interger.", "type": "string", "x-omitempty": true } } } ] }, "workflow.Api": { "title": "API", "description": "Intersight Orchestrator supports generic API workflow tasks that can execute\nan API given the request body and response parser specification.\nAPI type models a single API request within a batch of requests that get\nexecuted within a single workflow task.", "x-allOf-name": "workflow.Api", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Api', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsiblePlaySession", "workflow.CliCommand", "workflow.FileOperations", "workflow.PowerShellApi", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsiblePlaySession", "workflow.CliCommand", "workflow.FileOperations", "workflow.PowerShellApi", "workflow.SshSession", "workflow.WebApi", "workflow.XmlApi" ], "x-enum-as-string": true }, "AssetTargetMoid": { "description": "Asset target defines the remote target endpoints which are either managed by\nIntersight or their service APIs are invoked from Intersight. Generic API executor\nservice Jasmine can invoke these remote APIs via its executors. Asset targets can be\naccessed directly for cloud targets or via an associated Intersight Assist. Prerequisite\nto use asset targets is to persist the target details.\nAsset target MoRef can be given as task input of type TargetDataType. Fusion determines\nand populates the target context with the Assist if associated with. It is set\ninternally at the API level.\nIn case of an associated assist, it is used by Assist to fetch the target details\nand form the API request to send to endpoints. In case of cloud asset targets, Jasmine\nfetched the target details from DB, forms the API request and sends it to the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Body": { "description": "The optional request body that is sent as part of this API request.\nThe request body can contain a golang template that can be populated with task input\nparameters and previous API output parameters.", "type": "string", "x-omitempty": true }, "ContentType": { "description": "Intersight Orchestrator, with the support of response parser specification,\ncan extract the values from API responses and map them to task output parameters.\nThe value extraction is supported for response content types XML, JSON and Text.\nThe type of the content that gets passed as payload and response in this\nAPI. The supported values are json, xml, text.", "type": "string", "x-omitempty": true }, "Description": { "description": "A description that task designer can add to individual API requests that explain \nwhat the API call is about.", "type": "string", "x-omitempty": true }, "ErrorContentType": { "description": "Intersight Orchestrator, with the support of response parser specification,\ncan extract the values from API responses and map them to task output parameters.\nThe value extraction is supported for response content types XML, JSON and Text.\nOptional input to specify the content type in case of error API response. This\nshould be used if the content type of error response is different from that of\nthe success response. If not specified, contentType input value is used to parse\nthe error response.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly label that task designers have given to the batch API request.", "type": "string", "x-omitempty": true }, "Name": { "description": "A reference name for this API request within the batch API request.\nThis name shall be used to map the API output parameters to subsequent\nAPI input parameters within a batch API task.", "type": "string", "x-omitempty": true }, "Outcomes": { "description": "All the possible outcomes of this API are captured here. Outcomes property\nis a collection property of type workflow.Outcome objects.\nThe outcomes can be mapped to the message to be shown. The outcomes are\nevaluated in the order they are given. At the end of the outcomes list,\nan catchall success/fail outcome can be added with condition as 'true'.\nThis is an optional\nproperty and if not specified the task will be marked as success.", "nullable": true, "x-omitempty": true }, "ResponseSpec": { "description": "The optional grammar specification for parsing the response to extract the\nrequired values.\nThe specification should have extraction specification specified for\nall the API output parameters.", "nullable": true, "x-omitempty": true }, "SkipOnCondition": { "description": "The skip expression, if provided, allows the batch API executor to skip the\napi execution when the given expression evaluates to true.\nThe expression is given as such a golang template that has to be\nevaluated to a final content true/false. The expression is an optional and in\ncase not provided, the API will always be executed.", "type": "string", "x-omitempty": true }, "StartDelay": { "description": "The delay in seconds after which the API needs to be executed.\nBy default, the given API is executed immediately. Specifying a start delay adds to the delay to execution.\nStart Delay is not supported for the first API in the Batch and cumulative delay of all the APIs in the Batch should not exceed the task time out.", "type": "integer", "format": "int64", "x-omitempty": true }, "Timeout": { "description": "The duration in seconds by which the API response is expected from the API target.\nIf the end point does not respond for the API request within this timeout\nduration, the task will be marked as failed.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "workflow.ArrayDataType": { "title": "Workflow:Array Data Type", "description": "This data type represents an array of a given type. It can be an array of primitive data or of custom data.", "x-allOf-name": "workflow.ArrayDataType", "allOf": [ { "$ref": "#/components/schemas/workflow.BaseDataType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.ArrayDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.ArrayDataType" ], "default": "workflow.ArrayDataType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.ArrayDataType" ], "default": "workflow.ArrayDataType", "x-enum-as-string": true }, "ArrayItemType": { "description": "Data item within the array data type.", "$ref": "#/components/schemas/workflow.ArrayItem", "x-omitempty": true }, "Max": { "description": "Specify the maximum value of the array.", "type": "integer", "format": "int64", "x-omitempty": true }, "Min": { "description": "Specify the minimum value of the array.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "workflow.ArrayItem": { "title": "Workflow:Array Item", "description": "ArrayItem represents an array item within the array.", "x-allOf-name": "workflow.ArrayItem", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.AssociatedRoles": { "title": "Workflow:Associated Roles", "description": "AssociatedRoles models the inferred tasks to the required roles mapping cached in the\nworkflow definition.", "x-allOf-name": "workflow.AssociatedRoles", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.AssociatedRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.AssociatedRoles" ], "default": "workflow.AssociatedRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.AssociatedRoles" ], "default": "workflow.AssociatedRoles", "x-enum-as-string": true }, "Moid": { "description": "Stores the identifier of the task definition for which the required roles are cached\nin the workflow definition.\nIn the case of sub workflow tasks, this property stores the identifier of the workflow\nthat is wrapped in the sub workflow task.", "type": "string", "readOnly": true, "x-omitempty": true }, "PrivilegeSets": { "type": "array", "items": { "description": "Stores the identifiers of the privilege sets that are required to execute the task.\nThis is applicable only for worker tasks.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RequiredPrivilegeNames": { "type": "array", "items": { "description": "For tasks in this workflow that invoke Intersight APIs calls, the privileges required to invoke the APIs are collected in this property.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Roles": { "type": "array", "items": { "description": "Stores the identifiers of the required task roles in case of the worker task for which\nthe roles are cached.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TaskNames": { "type": "array", "items": { "description": "Stores the task reference names used within the workflow that refer to the task definition.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "WorkflowRoles": { "type": "array", "items": { "description": "Stores the required roles of the workflow definition in case of a sub workflow task.", "$ref": "#/components/schemas/workflow.AssociatedRoles", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workflow.BaseDataType": { "title": "Workflow:Base Data Type", "description": "The base data type that is used to derive all the other data types for inputs and outputs.", "x-allOf-name": "workflow.BaseDataType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BaseDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.ArrayDataType", "workflow.CustomDataType", "workflow.DynamicTemplateParserDataType", "workflow.MoInventoryDataType", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.PrimitiveDataType", "workflow.TargetDataType" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.ArrayDataType", "workflow.CustomDataType", "workflow.DynamicTemplateParserDataType", "workflow.MoInventoryDataType", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.PrimitiveDataType", "workflow.TargetDataType" ], "x-enum-as-string": true }, "Default": { "description": "Default value for the data type. If default value was provided and the input was required the default value will be used as the input.", "$ref": "#/components/schemas/workflow.DefaultValue", "x-omitempty": true }, "Description": { "description": "Provide a detailed description of the data type.", "type": "string", "x-omitempty": true }, "DisplayMeta": { "description": "Captures the meta data needed for displaying workflow data types in Intersight User Interface.", "$ref": "#/components/schemas/workflow.DisplayMeta", "x-omitempty": true }, "InputParameters": { "description": "JSON formatted mapping from other property of the definition to the current property. Input parameter mapping is supported only for custom data type property in workflow definition and custom data type definition. The format to specify mapping ina workflow definition when source property is of scalar types is '${workflow.input.property}'. The format to specify mapping when the source property is of object reference and mapping needs to be made to the property of the object is '${workflow.input.property.subproperty}'. The format to specify mapping in a custom data type definition is '${datatype.type.property}'. When the current property is of non-scalar type like composite custom data type, then mapping can be provided to the individual property of the custom data type like 'cdt_property:${workflow.input.property}'.", "x-omitempty": true }, "Label": { "description": "Descriptive label for the data type. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), space ( ), forward slash (/) or an underscore (_). The first and last character in label must be an alphanumeric character.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:/-]{1,92}$", "minLength": 1, "maxLength": 92, "x-omitempty": true }, "Name": { "description": "Descriptive name for the data type. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.", "type": "string", "pattern": "^[a-zA-Z0-9]+([a-zA-Z0-9-_]*[a-zA-Z0-9])*$", "minLength": 1, "maxLength": 92, "x-omitempty": true }, "Required": { "description": "Specifies whether this parameter is required. The field is applicable for task and workflow.", "type": "boolean", "x-omitempty": true } } } ] }, "workflow.BaseOperation": { "title": "Workflow:Base Operation", "description": "Specify operation type on a service item like deployment or post-deployment to be performed on catalog.", "x-allOf-name": "workflow.BaseOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BaseOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment" ], "x-enum-as-string": true }, "OperationType": { "description": "Type of action operation to be performed on the service item.\n* `PostDeployment` - This represents the post-deployment actions for the resources created or defined through the deployment action. There can be more than one post-deployment operations associated with a service item.\n* `Deployment` - This represents the deploy action, for the service item action definition. This operation type is used to create or define resources that is managed by the service item. There can only be one Service Item Action Definition that can be marked with the operation type as Deployment and this is a mandatory operation type. All valid Service Items must have one and only one operation type marked as type Deployment.\n* `Decommission` - This represents the decommission action, used to decommission the created resources. All valid Service Items must have one and only one operation type marked as type Decommission. Once a decommission action is run on a Service Item, no further operations are allowed on that Service Item.\n* `Migration` - This represents the migration action, used to migrate service item instance from one service item definition version to another service item definition version. There can be more than one migration operations associated with a service item. Once a migration action is running on a service item instance, no further operations are allowed on that service item instance during the migration process.", "type": "string", "enum": [ "PostDeployment", "Deployment", "Decommission", "Migration" ], "default": "PostDeployment", "x-createOnly": true, "x-omitempty": true } } } ] }, "workflow.BaseServiceItemActionProperty": { "title": "Workflow:Base Service Item Action Property", "description": "BaseServiceItemActionProperty is the abstract definition to capture the properties in ServiceItemActionProperties.", "x-allOf-name": "workflow.BaseServiceItemActionProperty", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "workflow.BatchApiExecutor.Response": { "description": "The response body of a HTTP GET request for the 'workflow.BatchApiExecutor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.BatchApiExecutor' resources.", "x-one-of-name": "workflow.BatchApiExecutor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.BatchApiExecutor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.BatchApiExecutor": { "title": "Batch API", "description": "The BatchApiExecutor object is a key component within the workflow system that facilitates the execution of multiple API requests as part of a single task execution. It is designed to handle batch operations efficiently, allowing users to define and execute a series of API calls in a cohesive manner.\n#### Purpose\nThe BatchApiExecutor serves as a mechanism to associate and manage a list of API requests that need to be executed together. This provides the ability to define API tasks using the API request body and a response parser specification, thus streamlining the execution process within a workflow.\n#### Key Concepts\n- **Batch Execution:** Enables the grouping and execution of multiple API requests as a single task, enhancing operational efficiency.\n- **Access Control:** Utilizes privilege sets to manage who can read, update, create, and delete batch API tasks, ensuring security and proper governance.\n- **Error Handling:** Integrates with error response handlers to provide robust mechanisms for parsing and managing error responses from API calls.", "x-allOf-name": "workflow.BatchApiExecutor", "allOf": [ { "$ref": "#/components/schemas/workflow.BatchExecutor" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BatchApiExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.BatchApiExecutor" ], "default": "workflow.BatchApiExecutor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.BatchApiExecutor" ], "default": "workflow.BatchApiExecutor", "x-enum-as-string": true }, "ErrorResponseHandler": { "$ref": "#/components/schemas/workflow.ErrorResponseHandler.Relationship", "description": "A reference to a workflowErrorResponseHandler resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "TaskDefinition": { "$ref": "#/components/schemas/workflow.TaskDefinition.Relationship", "description": "A reference to a workflowTaskDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.BatchApiExecutor.List": { "title": "List of 'workflow.BatchApiExecutor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.BatchApiExecutor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.BatchApiExecutor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.BatchApiExecutor" }, "nullable": true } } } ] }, "workflow.BatchExecutor": { "title": "Batch Executor", "description": "Intersight support for creating generic API tasks using the API request body and a response parser specification in the form of a content.Grammar object. \nThe Batch API associates a list of API requests to be executed as part of a single task, with each request containing a request body and a response parser specification.", "x-allOf-name": "workflow.BatchExecutor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.BatchExecutor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.PowerShellBatchApiExecutor", "workflow.SshBatchExecutor" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.PowerShellBatchApiExecutor", "workflow.SshBatchExecutor" ], "x-enum-as-string": true }, "Batch": { "type": "array", "items": { "description": "Support for one or a batch of APIs to be executed as part of the task's execution, with the batch being non-empty.", "$ref": "#/components/schemas/workflow.Api", "x-omitempty": true }, "minItems": 1, "nullable": true }, "CancelAction": { "type": "array", "items": { "description": "Support for one or a batch of APIs to be executed as part of the task's cancel action, with the option for an empty cancel action.", "$ref": "#/components/schemas/workflow.Api", "x-omitempty": true }, "minItems": 0, "nullable": true }, "Constraints": { "description": "Constraints for matching this task against the task definition.", "$ref": "#/components/schemas/workflow.TaskConstraints", "x-omitempty": true }, "Description": { "description": "Detailed description of the batch APIs.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the batch API task.", "type": "string", "x-omitempty": true }, "Outcomes": { "description": "Collection of possible task outcomes, represented as workflow.Outcome objects. Outcomes can be mapped to messages and are evaluated in the given order. \nA catch-all success or failure outcome with condition 'true' can be included at the end. Optional property; if not specified, the task defaults to success.", "nullable": true, "x-omitempty": true }, "Output": { "description": "JSON mapping of extracted API response values to task output parameters, using API response grammar defined in Intersight Orchestrator.", "nullable": true, "x-omitempty": true }, "RetryFromFailedApi": { "description": "Flag indicating if the retry task should from the failed API or the first API in the batch execution; default value is false.", "type": "boolean", "x-omitempty": true }, "SkipOnCondition": { "description": "Optional skip expression allowing the batch API executor to skip task execution when the provided Go template expression evaluates to true. \nIf not specified, the API will always be executed.", "type": "string", "x-omitempty": true }, "UiRenderingData": { "description": "Data required for rendering the task in the user interface.", "nullable": true, "x-omitempty": true } } } ] }, "workflow.CancelableType": { "title": "Workflow:Cancelable Type", "description": "Defines the conditions under which a workflow can be canceled.", "x-allOf-name": "workflow.CancelableType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CancelableType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CancelableType" ], "default": "workflow.CancelableType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CancelableType" ], "default": "workflow.CancelableType", "x-enum-as-string": true }, "CancelableStates": { "type": "array", "items": { "description": "List of workflow states at which the workflow is allowed to be canceled.", "type": "string", "x-omitempty": true }, "nullable": true }, "Enabled": { "description": "When true the workflow can be cancelled. The action can be further restricted by the mode and cancelableStates properties.", "type": "boolean", "default": true, "x-omitempty": true }, "Mode": { "description": "Mode controls how the workflow can be canceled.\n* `ApiOnly` - The workflow can only be canceled via API call.\n* `All` - The workflow can be canceled from API or from the user interface.", "type": "string", "enum": [ "ApiOnly", "All" ], "default": "ApiOnly", "x-omitempty": true } } } ] }, "workflow.Catalog.Response": { "description": "The response body of a HTTP GET request for the 'workflow.Catalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.Catalog' resources.", "x-one-of-name": "workflow.Catalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.Catalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.Catalog.Relationship": { "description": "A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value.", "x-one-of-name": "workflow.Catalog.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.Catalog" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.Catalog": { "title": "Workflow:Catalog", "description": "The Catalog object serves as a container for organizing definitions related to orchestration, including both workflow, task definitions and more.\n#### Purpose\nIt provides a structured way to manage and isolate orchestration assets. Each user account has a local catalog for private definitions, while Cisco provides shared catalogs containing validated workflows and tasks for use within the account context.\n#### Key Concepts\n- **Asset Organization:** Groups workflow and task definitions for better discovery and management.\n- **Access Context:** Supports both private account-level catalogs and shared, Cisco-managed catalogs.\n- **Namespace Management:** Ensures unique identification of orchestration assets within the organizational context.", "x-allOf-name": "workflow.Catalog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Catalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Catalog" ], "default": "workflow.Catalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Catalog" ], "default": "workflow.Catalog", "x-enum-as-string": true }, "Name": { "description": "A unique name for the catalog.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.Catalog.List": { "title": "List of 'workflow.Catalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.Catalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.Catalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.Catalog" }, "nullable": true } } } ] }, "workflow.CatalogItemDefinition.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CatalogItemDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CatalogItemDefinition' resources.", "x-one-of-name": "workflow.CatalogItemDefinition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CatalogItemDefinition.Relationship": { "description": "A relationship to the 'workflow.CatalogItemDefinition' resource, or the expanded 'workflow.CatalogItemDefinition' resource, or the 'null' value.", "x-one-of-name": "workflow.CatalogItemDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CatalogItemDefinition": { "title": "Catalog Item Definition", "description": "Catalog Item definition is a collection of Service items which are associated with workflow definition that can be used to deploy and manage service items.", "x-allOf-name": "workflow.CatalogItemDefinition", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CatalogItemDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CatalogItemDefinition" ], "default": "workflow.CatalogItemDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CatalogItemDefinition" ], "default": "workflow.CatalogItemDefinition", "x-enum-as-string": true }, "Description": { "description": "The description for the catalog item which provides information on what are the pre-requisites to deploy the resource.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the catalog item. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Name": { "description": "The name for this catalog item definition. You can have multiple versions of the catalog item with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "PublishStatus": { "description": "Publish status of the catalog item.\n* `Draft` - The enum specifies the option as Draft which means the meta definition is being designed and tested.\n* `Published` - The enum specifies the option as Published which means the meta definition is ready for consumption.\n* `Archived` - The enum specifies the option as Archived which means the meta definition is archived and can no longer be consumed.", "type": "string", "enum": [ "Draft", "Published", "Archived" ], "default": "Draft", "x-omitempty": true }, "ServiceItems": { "type": "array", "items": { "description": "Service item types associated with this catalog item.", "$ref": "#/components/schemas/workflow.ServiceItemType", "x-omitempty": true }, "nullable": true }, "SupportStatus": { "description": "The CatalogItem Support depicts the support status of catalog, the values will be any of Supported or Deprecated state. The user can create a Catalog Service Request if the support status is supported, if its Deprecated then it cannot be instantiated.\n* `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs.\n* `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported.\n* `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.", "type": "string", "enum": [ "Supported", "Beta", "Deprecated" ], "default": "Supported", "x-omitempty": true }, "UserIdOrEmail": { "description": "The user identifier who created or updated the catalog item definition.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidationInformation": { "description": "The current validation state of catalog and associated validation errors when state is invalid.", "$ref": "#/components/schemas/workflow.ValidationInformation", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the catalog item to support multiple versions.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "x-createOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workflow.CatalogItemDefinition.List": { "title": "List of 'workflow.CatalogItemDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CatalogItemDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CatalogItemDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition" }, "nullable": true } } } ] }, "workflow.CatalogServiceRequest.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CatalogServiceRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CatalogServiceRequest' resources.", "x-one-of-name": "workflow.CatalogServiceRequest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CatalogServiceRequest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CatalogServiceRequest.Relationship": { "description": "A relationship to the 'workflow.CatalogServiceRequest' resource, or the expanded 'workflow.CatalogServiceRequest' resource, or the 'null' value.", "x-one-of-name": "workflow.CatalogServiceRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CatalogServiceRequest": { "title": "Catalog Service Request", "description": "Catalog Service Request is one instance of a catalog item based on a catalog item definition.", "x-allOf-name": "workflow.CatalogServiceRequest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CatalogServiceRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CatalogServiceRequest" ], "default": "workflow.CatalogServiceRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CatalogServiceRequest" ], "default": "workflow.CatalogServiceRequest", "x-enum-as-string": true }, "Description": { "description": "The description for this catalog service request which provides information on request from the user.", "type": "string", "x-omitempty": true }, "EndTime": { "description": "The time at which the service request completed or stopped.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Input": { "description": "Inputs for a catalog service request instance creation, format is specified by input definition of the catalog item definition.", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the catalog service request instance. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ) or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Captures log messages for each of the service item contained in the catalog service request.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/servicerequest.Message", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "A name of the catalog service request instance.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,92}$", "x-omitempty": true }, "Operation": { "description": "Captures the operation to be performed as part of catalog service request.", "$ref": "#/components/schemas/workflow.BaseOperation", "x-omitempty": true }, "SelectionCriteriaInputs": { "type": "array", "items": { "description": "Captures the policy input, value and filter conditions which are used for extracting the value.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/serviceitem.SelectionCriteriaInput", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Status": { "description": "Status of the catalog service request instance which determines the actions that are allowed on this instance.\n* `NotCreated` - The service item is not yet created and it is in a draft mode. A service item instance can be deleted in this state.\n* `InProgress` - An action is in progress and until that action has reached a final state, another action cannot be started.\n* `Failed` - The last action on the service item instance failed and corrective measures need to be taken to bring the service item instance back to valid state.\n* `Okay` - The last action on the service item instance completed and the service item instance is in Okay state.\n* `Decommissioned` - The service item is decommissioned and can be safely deleted. A service item instance in any other state after it has been created cannot be deleted until it has been decommissioned.", "type": "string", "enum": [ "NotCreated", "InProgress", "Failed", "Okay", "Decommissioned" ], "default": "NotCreated", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The user identifier who invoked the request to create the catalog service request.", "type": "string", "readOnly": true, "x-omitempty": true }, "CatalogItemDefinition": { "$ref": "#/components/schemas/workflow.CatalogItemDefinition.Relationship", "description": "A reference to a workflowCatalogItemDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Idp": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IdpReference": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ServiceItemActionInstances": { "description": "An array of relationships to workflowServiceItemActionInstance resources.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.ServiceItemActionInstance.Relationship" }, "nullable": true, "readOnly": true }, "ServiceItemInstances": { "description": "An array of relationships to workflowServiceItemInstance resources.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.ServiceItemInstance.Relationship" }, "nullable": true, "readOnly": true }, "User": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "workflow.CatalogServiceRequest.List": { "title": "List of 'workflow.CatalogServiceRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CatalogServiceRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CatalogServiceRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CatalogServiceRequest" }, "nullable": true } } } ] }, "workflow.CliCommand": { "title": "CLI Command", "description": "This models a single CLI command that can be executed on the end point.", "x-allOf-name": "workflow.CliCommand", "allOf": [ { "$ref": "#/components/schemas/workflow.Api" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CliCommand', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CliCommand" ], "default": "workflow.CliCommand", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CliCommand" ], "default": "workflow.CliCommand", "x-enum-as-string": true }, "Command": { "description": "The command to run on the device connector.", "type": "string", "x-omitempty": true }, "EndPrompt": { "description": "The regex string that identifies the end of the command response.", "type": "string", "x-omitempty": true }, "ExpectPrompts": { "type": "array", "items": { "description": "Cli prompts required as part of interactive command execution. For e.g. login credentials will be part of prompts\nwhich are provided as list of expect prompt regex and corresponding answer string.", "$ref": "#/components/schemas/workflow.ExpectPrompt", "x-omitempty": true }, "nullable": true }, "ExpectedExitCodes": { "type": "array", "items": { "description": "Optional array of integer values to specify the expected exit codes of a CLI command. CLI command execution\nis marked success upon receiving any of the expected exit code from command execution. If not set, success\nexit code of 0 is expected from command execution.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "SkipStatusCheck": { "description": "Skips the execution status check of the terminal command. One use case for this is while exiting the\nterminal session from esxi host.", "type": "boolean", "x-omitempty": true }, "TerminalEnd": { "description": "If this flag is set, it marks the end of the terminal session where the previous commands were executed.", "type": "boolean", "x-omitempty": true }, "TerminalStart": { "description": "If this flag is set, the execution of this command initiates a terminal session in which the subsequent\nCLI commands are executed until a command with terminalEnd flag is encountered or the end of the batch.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "The type of the command - can be interactive or non-interactive.\n* `NonInteractive` - The CLI command is not an interactive command.\n* `Interactive` - The CLI command is executed in interactive mode and the command must provide the expects andanswers.", "type": "string", "enum": [ "NonInteractive", "Interactive" ], "default": "NonInteractive", "x-omitempty": true } } } ] }, "workflow.Comments": { "title": "Workflow:Comments", "description": "Contains detailed information about template function.", "x-allOf-name": "workflow.Comments", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Comments', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Comments" ], "default": "workflow.Comments", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Comments" ], "default": "workflow.Comments", "x-enum-as-string": true }, "Description": { "description": "Description field provides comment about the template function.", "type": "string", "x-omitempty": true }, "Examples": { "type": "array", "items": { "description": "The example describes the invocation method for template API.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "workflow.Constraints": { "title": "Workflow:Constraints", "description": "Captures the constraints for valid parameter values.", "x-allOf-name": "workflow.Constraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.Constraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.Constraints" ], "default": "workflow.Constraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.Constraints" ], "default": "workflow.Constraints", "x-enum-as-string": true }, "EnumList": { "type": "array", "items": { "description": "When the parameter is a enum then this list of enum entry is used to validate the input belongs to one of items in the list.", "$ref": "#/components/schemas/workflow.EnumEntry", "x-omitempty": true }, "nullable": true }, "Max": { "description": "Allowed maximum value of the parameter if parameter is integer/float or maximum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then maximum number supported is 1.797693134862315708145274237317043567981e+308 or (2**1023 * (2**53 - 1) / 2**52). When a number bigger than this is given as Maximum value, the constraints will not be enforced.", "type": "number", "format": "double", "x-omitempty": true }, "Min": { "description": "Allowed minimum value of the parameter if parameter is integer/float or minimum length of the parameter if the parameter is string. When max and min are set to 0, then the limits are not checked. If parameter is integer/float, then minimum number supported is 4.940656458412465441765687928682213723651e-324 or (1 / 2 ** (1023 - 1 + 52)). When a number smaller than this is given as minimum value, the constraints will not be enforced.", "type": "number", "format": "double", "x-omitempty": true }, "Regex": { "description": "When the parameter is a string this regular expression is used to ensure the value is valid.", "type": "string", "x-omitempty": true } } } ] }, "workflow.ControlTask": { "title": "Workflow:Control Task", "description": "Control tasks run within the workflow engine and are not executed by remote worker microservices. They are used to modify flow of control within a workflow.", "x-allOf-name": "workflow.ControlTask", "allOf": [ { "$ref": "#/components/schemas/workflow.WorkflowTask" } ] }, "workflow.CustomArrayItem": { "title": "Workflow:Custom Array Item", "description": "Captures an array of custom datatype items.", "x-allOf-name": "workflow.CustomArrayItem", "allOf": [ { "$ref": "#/components/schemas/workflow.ArrayItem" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomArrayItem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomArrayItem" ], "default": "workflow.CustomArrayItem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomArrayItem" ], "default": "workflow.CustomArrayItem", "x-enum-as-string": true }, "Properties": { "description": "Captures an array item which is of custom data type.", "$ref": "#/components/schemas/workflow.CustomDataProperty", "x-omitempty": true } } } ] }, "workflow.CustomDataProperty": { "title": "Workflow:Custom Data Property", "description": "Capture all the properties for Custom data type.", "x-allOf-name": "workflow.CustomDataProperty", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataProperty', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataProperty" ], "default": "workflow.CustomDataProperty", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataProperty" ], "default": "workflow.CustomDataProperty", "x-enum-as-string": true }, "CatalogMoid": { "description": "Specify the catalog moid that this custom data type belongs.", "type": "string", "x-omitempty": true }, "CustomDataTypeId": { "description": "The resolved custom data type definition managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "CustomDataTypeName": { "description": "Name of the custom data type for this input.", "type": "string", "x-omitempty": true } } } ] }, "workflow.CustomDataType": { "title": "Workflow:Custom Data Type", "description": "This data type represents a custom data object.", "x-allOf-name": "workflow.CustomDataType", "allOf": [ { "$ref": "#/components/schemas/workflow.BaseDataType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataType" ], "default": "workflow.CustomDataType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataType" ], "default": "workflow.CustomDataType", "x-enum-as-string": true }, "Properties": { "description": "Captures the custom data type properties.", "$ref": "#/components/schemas/workflow.CustomDataProperty", "x-omitempty": true } } } ] }, "workflow.CustomDataTypeDefinition.Response": { "description": "The response body of a HTTP GET request for the 'workflow.CustomDataTypeDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workflow.CustomDataTypeDefinition' resources.", "x-one-of-name": "workflow.CustomDataTypeDefinition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workflow.CustomDataTypeDefinition.Relationship": { "description": "A relationship to the 'workflow.CustomDataTypeDefinition' resource, or the expanded 'workflow.CustomDataTypeDefinition' resource, or the 'null' value.", "x-one-of-name": "workflow.CustomDataTypeDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "workflow.CustomDataTypeDefinition": { "title": "Custom Datatype", "description": "The CustomDataTypeDefinition object provides a framework for defining customized data types used within workflows, enhancing flexibility and reusability.\n#### Purpose\nCustomDataTypeDefinition allows users to create and manage data types that can be used as inputs or outputs in workflows, tailoring data handling to specific use cases and requirements.\n#### Key Concepts\n- **Flexibility:** Supports the creation of complex data structures that can be reused across multiple workflows.\n- **Type Management:** Provides capabilities to define properties, constraints, and relationships for custom data types.", "x-allOf-name": "workflow.CustomDataTypeDefinition", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataTypeDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataTypeDefinition" ], "default": "workflow.CustomDataTypeDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataTypeDefinition" ], "default": "workflow.CustomDataTypeDefinition", "x-enum-as-string": true }, "CompositeType": { "description": "When true this data type definition is a collection of type definitions to represent composite data like JSON.", "type": "boolean", "default": false, "x-omitempty": true }, "Description": { "description": "A human-friendly description of this custom data type indicating it's domain and usage.", "type": "string", "x-omitempty": true }, "Label": { "description": "A user friendly short name to identify the custom data type definition. Label can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ), single quote ('), or an underscore (_) and must be at least 2 characters.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]{1,92}$", "x-omitempty": true }, "Name": { "description": "The name of custom data type definition. The valid name can contain lower case and upper case alphabetic characters, digits and special characters '-' and '_'.", "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "x-createOnly": true, "x-omitempty": true }, "ParameterSet": { "type": "array", "items": { "description": "Parameter set rules that will govern the applicability of parameters.", "$ref": "#/components/schemas/workflow.ParameterSet", "x-omitempty": true }, "nullable": true }, "Properties": { "description": "Type to capture all the properties for the custom data type definition.", "$ref": "#/components/schemas/workflow.CustomDataTypeProperties", "x-omitempty": true }, "TypeDefinition": { "type": "array", "items": { "description": "The properties of this custom data type definition.", "$ref": "#/components/schemas/workflow.BaseDataType", "x-omitempty": true }, "nullable": true }, "Catalog": { "$ref": "#/components/schemas/workflow.Catalog.Relationship", "description": "A reference to a workflowCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "ClonedFrom": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition.Relationship", "description": "A reference to a workflowCustomDataTypeDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "workflow.CustomDataTypeDefinition.List": { "title": "List of 'workflow.CustomDataTypeDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workflow.CustomDataTypeDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workflow.CustomDataTypeDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workflow.CustomDataTypeDefinition" }, "nullable": true } } } ] }, "workflow.CustomDataTypeProperties": { "title": "Workflow:Custom Data Type Properties", "description": "Properties for a custom data type definition.", "x-allOf-name": "workflow.CustomDataTypeProperties", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.CustomDataTypeProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.CustomDataTypeProperties" ], "default": "workflow.CustomDataTypeProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.CustomDataTypeProperties" ], "default": "workflow.CustomDataTypeProperties", "x-enum-as-string": true }, "Cloneable": { "description": "When set to false custom data type is not cloneable. It is set to true only if data type is not internal and it is not using any internal custom data type.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "ExternalMeta": { "description": "When set to false the custom data type is owned by the system and used for internal services. Such custom data type cannot be directly used by external entities.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "SupportStatus": { "description": "Supported status of the definition.\n* `Supported` - The definition is a supported version and there will be no changes to the mandatory inputs or outputs.\n* `Beta` - The definition is a Beta version and this version can under go changes until the version is marked supported.\n* `Deprecated` - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.", "type": "string", "enum": [ "Supported", "Beta", "Deprecated" ], "default": "Supported", "x-omitempty": true } } } ] }, "workflow.DataSourceSelector": { "title": "Workflow:Data Source Selector", "description": "An alternative selector to MoReferenceProperty that serves as a data source for PrimitiveDataTypes. It supports selecting data from workflow execution sources, including workflow inputs and outputs from previous tasks.", "x-allOf-name": "workflow.DataSourceSelector", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DataSourceSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DataSourceSelector" ], "default": "workflow.DataSourceSelector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DataSourceSelector" ], "default": "workflow.DataSourceSelector", "x-enum-as-string": true }, "DisplayAttributes": { "type": "array", "items": { "description": "List of properties from the mapped parameter.", "type": "string", "x-omitempty": true }, "minItems": 1, "nullable": true }, "Selector": { "description": "This field holds mapping information used to provide suggestions to the user. The mapping should be in the '${workflow.input.property}' format. It supports workflow input mapping for workflows, and for User Actions, it supports workflow inputs, workflow outputs, workflow variables, and outputs from previous tasks.", "type": "string", "x-omitempty": true }, "ValueAttribute": { "description": "A property from the mapped parameter, value of which can be used as value for referenced input definition.", "type": "string", "x-omitempty": true } } } ] }, "workflow.DecisionCase": { "title": "Workflow:Decision Case", "description": "A Decision Case is a condition for a Decision Task. It is the equivalent of case statement in the programming language paradigm of switch and case.", "x-allOf-name": "workflow.DecisionCase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DecisionCase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DecisionCase" ], "default": "workflow.DecisionCase", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DecisionCase" ], "default": "workflow.DecisionCase", "x-enum-as-string": true }, "Description": { "description": "Description of this decision case.", "type": "string", "x-omitempty": true }, "NextTask": { "description": "The name of the next task (Task names unique within workflow) to run. In a graph model, denotes an edge to another Task Node.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value for the decision case.", "type": "string", "x-omitempty": true } } } ] }, "workflow.DecisionTask": { "title": "Workflow:Decision Task", "description": "A DecisionTask is a control task that executes a sequence of WorkflowTasks based off decision provided and evaluated by this task.", "x-allOf-name": "workflow.DecisionTask", "allOf": [ { "$ref": "#/components/schemas/workflow.ControlTask" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DecisionTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DecisionTask" ], "default": "workflow.DecisionTask", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DecisionTask" ], "default": "workflow.DecisionTask", "x-enum-as-string": true }, "Condition": { "description": "The condition to evaluate for this decision task. The condition can be a workflow or task variable or an JavaScript expression. Example value for condition could be a variable like \"${task1.output.var1} or ${workflow.input.var2}\" which evaluates to a value matching any of the decision case values. Example value for condition if it's an expression - \"if ( ${task1.output.var1} ! = null && ${task1.output.var1} > 0 ) 'true'; else 'false'; \" which evaluates to 'true' or 'false' and will match one of the decision case values. You can also use JavaScript functions like indexOf, toUpperCase in the expression which will be evaluated by the expression evaluator.", "type": "string", "x-omitempty": true }, "DecisionCases": { "type": "array", "items": { "description": "A list of potential decision task flows based off a condition.", "$ref": "#/components/schemas/workflow.DecisionCase", "x-omitempty": true }, "nullable": true }, "DefaultTask": { "description": "The default next Task to execute if the decision cannot be evaluated to any of the DecisionCases.", "type": "string", "x-omitempty": true }, "InputParameters": { "description": "This field is deprecated. Decision case conditions can be added using the workflow input or task output variables in the Condition field. Refer to Condition field for more details.", "deprecated": true, "x-sunset": "2027-03-01", "x-omitempty": true } } } ] }, "workflow.DefaultValue": { "title": "Workflow:Default Value", "description": "Captures default vales for a data type.", "x-allOf-name": "workflow.DefaultValue", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DefaultValue', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DefaultValue" ], "default": "workflow.DefaultValue", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DefaultValue" ], "default": "workflow.DefaultValue", "x-enum-as-string": true }, "IsValueSet": { "description": "A flag that indicates whether a default value is given or not. This flag will be useful in case of the secure parameter where the value will be filtered out in API responses.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Override": { "description": "Override the default value provided for the data type. When true, allow the user to enter value for the data type.", "type": "boolean", "x-omitempty": true }, "Value": { "description": "Default value for the data type. If default value was provided and the input was required the default value will be used as the input.", "nullable": true, "x-omitempty": true } } } ] }, "workflow.DisplayMeta": { "title": "Workflow:Display Meta", "description": "Captures the meta data needed for displaying workflow data types in Intersight User Interface.", "x-allOf-name": "workflow.DisplayMeta", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workflow.DisplayMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workflow.DisplayMeta" ], "default": "workflow.DisplayMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workflow.DisplayMeta" ], "default": "workflow.DisplayMeta", "x-enum-as-string": true }, "InventorySelector": { "description": "Inventory selector specified for primitive data property should be used in Intersight User Interface.", "type": "boolean", "default": true, "x-omitempty": true }, "WidgetType": { "description": "Specify the widget type for data display.\n* `None` - Display none of the widget types.\n* `Radio` - Display the widget as a radio button.\n* `Dropdown` - Display the widget as a dropdown.\n* `GridSelector` - Display the widget as a selector.\n* `DrawerSelector` - Display the widget as a selector.\n* `MultiSelect` - Display the widget as a multi-select.\n* `Switcher` - Display the widget as a switcher.", "type": "string", "enum": [ "None", "Radio", "Dropdown", "GridSelector", "DrawerSelector", "MultiSelect", "Switcher" ], "default": "None", "x-omitempty": true } } } ] }, "workflow.DynamicTemplateParserDataType": { "title": "Workflow:Dynamic Template Parser Data Type", "description": "Data type to fetch a generic template from given selector and parse it using an api to give an array of secure and non-secure keys for form generation. URL used to fetch the template object is based on the templateType. Final input passed to the workflow using this data type is a JSON containing {'Template':'