{ "openapi": "3.0.1", "info": { "title": "REST API.", "version": "1.0.0", "x-provenance": { "method": "harvested", "authored_by": "Cisco XDR", "harvested_by": "API Evangelist", "harvested_on": "2026-08-19", "first_party": true, "provider_published": true, "source_host": "visibility.amp.cisco.com", "note": "Anonymously fetchable Swagger 2.0 for nine IROH services plus the CTIA threat-intelligence API. The host returns real 404s on invented paths, so the 200s are genuine." }, "x-evidence": [ { "type": "source", "url": "https://visibility.amp.cisco.com/iroh/iroh-int/swagger.json" }, { "type": "source", "url": "https://private.intel.amp.cisco.com/swagger.json" } ] }, "servers": [ { "url": "https://automate.us.security.cisco.com/{basePath}", "variables": { "basePath": { "default": "api" } } } ], "paths": { "/v1.1/instances": { "post": { "tags": [ "WorkflowInstances" ], "summary": "Handler to get all Workflow Instances.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getAllWorkflowInstancesQueryParams", "parameters": [ { "name": "state", "in": "query", "description": "The state of workflow.", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "search", "in": "query", "description": "The search term to filter workflow by workflow display name", "schema": { "type": "string", "x-go-name": "Search" }, "x-go-name": "Search" }, { "name": "start", "in": "query", "description": "Start return list of instances from the number specified", "schema": { "type": "integer", "format": "uint8", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "limit", "in": "query", "description": "Number of workflow instances will return by this request, must between 0-100", "required": true, "schema": { "type": "integer", "format": "uint8", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "date_from", "in": "query", "description": "Return instances that started on after this date or on this date, example date is 2019-05-19T00:00:00Z", "required": true, "schema": { "type": "string", "format": "date-time", "x-go-name": "DateFrom" }, "x-go-name": "DateFrom" }, { "name": "date_to", "in": "query", "description": "Return instances that are started on before this date or on this date, example date is 2019-05-19T00:00:00Z", "schema": { "type": "string", "format": "date-time", "x-go-name": "DateTo" }, "x-go-name": "DateTo" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsInstancePostRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An WFInstanceResponse response model\n\n# This is used for returning a response with a workflow instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WFInstancePaginationResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1.1/workflows": { "post": { "tags": [ "Workflows" ], "summary": "Handler to get all workflows.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow\nMandatory Query Param: limit -> Non Negative limit.", "operationId": "getAllWorkflowsPostQueryParams", "parameters": [ { "name": "is_atomic", "in": "query", "description": "Provide true to return only atomic workflows and false for non atomic. Skip to return all workflows.", "schema": { "type": "boolean", "x-go-name": "IsAtomic" }, "x-go-name": "IsAtomic" }, { "name": "search", "in": "query", "description": "Comma separated list of search terms to filter based on workflow names", "schema": { "type": "string", "x-go-name": "Search" }, "x-go-name": "Search" }, { "name": "state", "in": "query", "description": "Comma separated list of workflow states to filter", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "limit", "in": "query", "description": "Number of workflows to return for this request", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of workflows from n'th workflow, n is start to be provided", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Return list of workflows in sorted order", "schema": { "type": "string", "x-go-name": "SortBy" }, "x-go-name": "SortBy" }, { "name": "from_playbook", "in": "query", "description": "Provided true to return all the workflows that have at least one observable_type added to them.", "schema": { "type": "boolean", "x-go-name": "FromPlaybook" }, "x-go-name": "FromPlaybook" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsPostRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An WorkflowResponse response model\n\n# This is used for returning a response with a single workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowGetAllPaginationResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1.1/workflows/start": { "post": { "tags": [ "Workflows" ], "summary": "Handler to start workflow execution.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have RUN permission to given workflow", "operationId": "startWorkflowRequestV1Dot1", "parameters": [ { "name": "workflow_id", "in": "query", "description": "ID of the Workflow, to start workflow using id. (Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "unique_name", "in": "query", "description": "Unique Name of the Workflow, to start workflow using unique_name of it\n(Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "UniqueName" }, "x-go-name": "UniqueName" }, { "name": "sync", "in": "query", "description": "if true, starts workflow with sync.\nIf workflow execution takes more than 28 second, API returns the current status of the instance\nand workflow continue to run in the background\nAPI returns 200 Ok on successful completion of instance\nAPI return 201 Accepted if the workflow still in running state after 28 second", "schema": { "type": "boolean", "x-go-name": "Sync" }, "x-go-name": "Sync" }, { "name": "async", "in": "query", "description": "if true, workflow execution is processed asynchronously", "schema": { "type": "boolean", "x-go-name": "Async" }, "x-go-name": "Async" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file_name": { "type": "string", "description": "Upload File\nSwagger UI supports only one file to upload\nIn case of multiple input file variables use separate rest client", "format": "binary", "x-go-name": "File" }, "request_body": { "type": "string", "description": "The workflow to submit.\nPlease refer /v1/workflows/start API for request_body payload", "x-go-name": "RequestBody" } } } } } }, "responses": { "200": { "description": "An RunWorkflowResponse response model\n\n# This is used for returning a response of workflow as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StartWorkflowResponse" } } } } }, "202": { "description": "An RunWorkflowResponse response model\n\n# This is used for returning a response of workflow as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StartWorkflowResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1.2/workflows": { "post": { "tags": [ "Workflows" ], "summary": "Handler to get all workflows.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow\nMandatory Query Param: limit -> Non Negative limit.", "operationId": "getAllWorkflowsPostQueryParamsV1Dot2", "parameters": [ { "name": "is_atomic", "in": "query", "description": "Provide true to return only atomic workflows and false for non atomic. Skip to return all workflows.", "schema": { "type": "boolean", "x-go-name": "IsAtomic" }, "x-go-name": "IsAtomic" }, { "name": "search", "in": "query", "description": "Comma separated list of search terms to filter based on workflow names", "schema": { "type": "string", "x-go-name": "Search" }, "x-go-name": "Search" }, { "name": "state", "in": "query", "description": "Comma separated list of workflow states to filter", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "limit", "in": "query", "description": "Number of workflows to return for this request", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of workflows from n'th workflow, n is start to be provided", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Return list of workflows in sorted order, supported values are 'updated_on' and 'atomic_group'", "schema": { "type": "string", "x-go-name": "SortBy" }, "x-go-name": "SortBy" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsPostRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An WorkflowResponse response model\n\n# This is used for returning a response with a single workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowGetAllPaginationResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/calendars": { "get": { "tags": [ "Calendars" ], "summary": "Handler to get all calendars.", "description": "Allowed Role(s): admin, user, sat", "operationId": "listCalendars", "responses": { "200": { "description": "An CalendarResponse response model\n\n# This is used to return response with a single calendar as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Calendars" ], "summary": "Handler to create a Calendar.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Calendar.", "operationId": "calendarCreateRequest", "requestBody": { "description": "The calendar to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An CalendarDefinitonResponse response model\n\n# This is used to retutn a response of Calendar as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "422": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/calendars/batch_get": { "post": { "tags": [ "Calendars" ], "summary": "Handler to get all calendars paginated.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllCalendarsParam", "responses": { "200": { "description": "An GetAllCalendarSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllCalendarPaginatedResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/calendars/{calendar_id}": { "get": { "tags": [ "Calendars" ], "summary": "Handler to get a specific calendar.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getCalendarById", "parameters": [ { "name": "calendar_id", "in": "path", "description": "The definitionId of calendar", "required": true, "schema": { "type": "string", "x-go-name": "CalndarID" }, "x-go-name": "CalndarID" } ], "responses": { "200": { "description": "An CalendarDefinitonResponse response model\n\n# This is used to retutn a response of Calendar as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Calendars" ], "summary": "Handler to update calendar. Allows partial update", "description": "Allowed Role(s): admin", "operationId": "calendarUpdateRequest", "parameters": [ { "name": "calendar_id", "in": "path", "description": "The definitionId of calendar", "required": true, "schema": { "type": "string", "x-go-name": "CalndarID" }, "x-go-name": "CalndarID" } ], "requestBody": { "description": "The calendar to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An CalendarDefinitonResponse response model\n\n# This is used to retutn a response of Calendar as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "422": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Calendars" ], "summary": "Handler for delete calendar.", "description": "Allowed Role(s): admin", "operationId": "deleteCalendarById", "parameters": [ { "name": "calendar_id", "in": "path", "description": "The definitionId of calendar", "required": true, "schema": { "type": "string", "x-go-name": "CalndarID" }, "x-go-name": "CalndarID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/categories": { "get": { "tags": [ "Categories" ], "summary": "Handler to get all Categories.", "description": "Allowed Role(s): admin, user, sat", "operationId": "listCategories", "parameters": [ { "name": "type", "in": "query", "description": "Type of Category.", "schema": { "type": "string", "x-go-name": "Type" }, "x-go-name": "Type" } ], "responses": { "200": { "description": "An CategoryResponse response model\n\n# This is used to return response with a single category as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryGetResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Categories" ], "summary": "Handler to create a Category.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Category.", "operationId": "categoryCreateRequest", "requestBody": { "description": "The category to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An CategoryDefinitonResponse response model\n\n# This is used to retutn a response of Category as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "422": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/categories/{category_id}": { "get": { "tags": [ "Categories" ], "summary": "Handler to get a specific category.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getCategoryById", "parameters": [ { "name": "category_id", "in": "path", "description": "The definitionId of category", "required": true, "schema": { "type": "string", "x-go-name": "CategoryID" }, "x-go-name": "CategoryID" } ], "responses": { "200": { "description": "An CategoryDefinitonResponse response model\n\n# This is used to retutn a response of Category as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Categories" ], "summary": "Handler to update category. Allows partial update", "description": "Allowed Role(s): admin", "operationId": "categoryUpdateRequest", "parameters": [ { "name": "category_id", "in": "path", "description": "The definitionId of category", "required": true, "schema": { "type": "string", "x-go-name": "CategoryID" }, "x-go-name": "CategoryID" } ], "requestBody": { "description": "The category to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An CategoryDefinitonResponse response model\n\n# This is used to retutn a response of Category as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "422": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Categories" ], "summary": "Handler for delete Category.", "description": "Allowed Role(s): admin", "operationId": "deleteCategoryById", "parameters": [ { "name": "category_id", "in": "path", "description": "The definitionId of category", "required": true, "schema": { "type": "string", "x-go-name": "CategoryID" }, "x-go-name": "CategoryID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/change_owner/{entity_id}": { "put": { "tags": [ "ChangeOwner" ], "summary": "# Handler to update of owner for any entity", "description": "Allowed Role(s): admin\nNote: admin can change owner only for Roles in AO", "operationId": "changeOwnerUpdateRequest", "parameters": [ { "name": "entity_id", "in": "path", "description": "The entityID of entity", "required": true, "schema": { "type": "string", "x-go-name": "EntityID" }, "x-go-name": "EntityID" } ], "requestBody": { "description": "The change owner to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOwnerRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ChangeOwnerResponse response model\n\n# This is used for returning a response for change owner of entity as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOwnerRequest" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/comments": { "post": { "tags": [ "Comments" ], "summary": "Create comment.", "description": "This endpoint allows users to add a comment.", "operationId": "commentCreateRequest", "requestBody": { "description": "The target to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "CommentResponse\n\nThis is used for returning a comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/comments/batch_get": { "post": { "tags": [ "Comments" ], "summary": "Get all comments.", "description": "This endpoint allows users to get all comments by filter.", "operationId": "getAllCommentsQueryParam", "parameters": [ { "name": "limit", "in": "query", "description": "Number of comments to return for this request", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of comments from n'th comment, n is start to be provided", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Return list of comments in sorted order", "schema": { "type": "string", "x-go-name": "SortBy" }, "x-go-name": "SortBy" }, { "name": "order", "in": "query", "description": "Return list of comments in sorted order of asc/desc", "schema": { "type": "string", "x-go-name": "Order" }, "x-go-name": "Order" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequestParams" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An GetAllCommentsSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllCommentsResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/events": { "get": { "tags": [ "Events" ], "summary": "# Handler to get all events information", "description": "Allowed Role(s): admin, user, sat", "operationId": "GetAllEvents", "responses": { "200": { "description": "An EventsResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Events" ], "summary": "# Handler to create a event", "description": "Allowed Role(s): admin, user\n\nEither ViewSchemaID or Type or both in request body can be provided to create an Event.", "operationId": "EventCreateRequest", "requestBody": { "description": "The event to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An EventResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/events/{event_id}": { "get": { "tags": [ "Events" ], "summary": "readEventByID Handler to return Event infomration.", "description": "Allowed Role(s): admin, user, sat", "operationId": "GeEventByID", "parameters": [ { "name": "event_id", "in": "path", "description": "An ID of event", "required": true, "schema": { "type": "string", "x-go-name": "EventID" }, "x-go-name": "EventID" } ], "responses": { "200": { "description": "An EventResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Events" ], "summary": "# Handler to update event", "description": "Allowed Role(s): admin", "operationId": "EventUpdateRequest", "parameters": [ { "name": "event_id", "in": "path", "description": "The eventID of Event", "required": true, "schema": { "type": "string", "x-go-name": "EventID" }, "x-go-name": "EventID" } ], "requestBody": { "description": "The event to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An EventResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Events" ], "summary": "# Handler to delete event", "description": "Allowed Role(s): admin", "operationId": "DeleteEventByID", "parameters": [ { "name": "event_id", "in": "path", "description": "An ID of event", "required": true, "schema": { "type": "string", "x-go-name": "EventID" }, "x-go-name": "EventID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/instances": { "get": { "tags": [ "WorkflowInstances" ], "summary": "Handler to get all Workflow Instances.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "listWorkflowInstancesV1", "parameters": [ { "name": "workflow_id", "in": "query", "description": "An ID of workflow.", "required": true, "schema": { "type": "string", "x-go-name": "WoprkflowID" }, "x-go-name": "WoprkflowID" } ], "responses": { "200": { "description": "An WFInstanceResponseV1 response model\n\n# This is used for returning a response with a workflow instance as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowInstanceGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/instances/remove": { "post": { "tags": [ "WorkflowInstances" ], "summary": "Handler to delete workflow instances in a batch.", "description": "Allowed Role(s): admin", "operationId": "WorkflowInstanceBatchDeletePostRequest", "parameters": [ { "name": "state", "in": "query", "description": "Comma separated list of The state of instance.", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "date_from", "in": "query", "description": "Return instances that started on after this date or on this date, example date is 2019-05-19T00:00:00Z", "schema": { "type": "string", "format": "date-time", "x-go-name": "DateFrom" }, "x-go-name": "DateFrom" }, { "name": "date_to", "in": "query", "description": "Return instances that are started on before this date or on this date, example date is 2019-05-19T00:00:00Z", "schema": { "type": "string", "format": "date-time", "x-go-name": "DateTo" }, "x-go-name": "DateTo" } ], "requestBody": { "description": "workflow instance IDs for deleting the specified instances in the list or workflow definition ID for deleting\nthe instances associated with the workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInstanceBatchDeletePostReq" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "202": { "description": "An WorkflowInstanceDeleteResponse response model\n\n# Returns message not marked for deletion if workflow instances are in running state", "headers": { "message": { "schema": { "type": "string" } } }, "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/instances/summary": { "get": { "tags": [ "WorkflowInstances" ], "summary": "Handler to get a summary of workflows instances.", "description": "Including total number of instances, total number of canceled, failed, running and successful instances\nAllowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to workflow", "operationId": "instancesSummaryQueryParam", "parameters": [ { "name": "workflow_id", "in": "query", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "An GetInstancesSummaryResponse model.\n\n# It will return a summary of workflows", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instancesSummaryResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/instances/{wf_instance_id}": { "get": { "tags": [ "WorkflowInstances" ], "summary": "Handler returning workflow instance information.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getWFInstanceById", "parameters": [ { "name": "wf_instance_id", "in": "path", "description": "The Id of worklfow instance", "required": true, "schema": { "type": "string", "x-go-name": "WFInstanceID" }, "x-go-name": "WFInstanceID" }, { "name": "detailed", "in": "query", "description": "Whether to return all block instances for an instance if it has blocks\nIf false, will only return first block instance and a block count", "schema": { "type": "boolean", "x-go-name": "Detailed" }, "x-go-name": "Detailed" } ], "responses": { "200": { "description": "An WorkflowInstanceResponse response model\n\n# This is used for returning a response of workflow instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInstanceGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "WorkflowInstances" ], "summary": "Handler to manage(cancel/pause/resume) a specific workflow instance", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have RUN permission to given workflow", "operationId": "ManageWFInstanceByID", "parameters": [ { "name": "wf_instance_id", "in": "path", "description": "The Id of worklfow instance", "required": true, "schema": { "type": "string", "x-go-name": "WFInstanceID" }, "x-go-name": "WFInstanceID" }, { "name": "cancel", "in": "query", "description": "True for canceling an running/created status instance", "schema": { "type": "boolean", "x-go-name": "Cancel" }, "x-go-name": "Cancel" }, { "name": "pause", "in": "query", "description": "True for pause an instance has running status", "schema": { "type": "boolean", "x-go-name": "Pause" }, "x-go-name": "Pause" }, { "name": "resume", "in": "query", "description": "True for resume an instance has paused status", "schema": { "type": "boolean", "x-go-name": "Resume" }, "x-go-name": "Resume" }, { "name": "rerun", "in": "query", "description": "True for run an instance has failed status", "schema": { "type": "boolean", "x-go-name": "ReRun" }, "x-go-name": "ReRun" } ], "responses": { "200": { "description": "An ManageInstanceResponse response model\n\n# Return instance status", "headers": { "status": { "schema": { "type": "string" } } }, "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "delete": { "tags": [ "WorkflowInstances" ], "summary": "Handler for delete workflow instance.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "deleteWFInstanceById", "parameters": [ { "name": "wf_instance_id", "in": "path", "description": "The Id of worklfow instance", "required": true, "schema": { "type": "string", "x-go-name": "WFInstanceID" }, "x-go-name": "WFInstanceID" } ], "responses": { "202": { "description": "An WorkflowInstanceDeleteResponse response model\n\n# Returns message not marked for deletion if workflow instances are in running state", "headers": { "message": { "schema": { "type": "string" } } }, "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/instances/{wf_instance_id}/actions/{action_instance_id}": { "get": { "tags": [ "WorkflowInstances" ], "summary": "Handler returning information about action's instance.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getWFActionInstanceById", "parameters": [ { "name": "wf_instance_id", "in": "path", "description": "The Id of worklfow instance", "required": true, "schema": { "type": "string", "x-go-name": "WFInstanceID" }, "x-go-name": "WFInstanceID" }, { "name": "action_instance_id", "in": "path", "description": "The Id of worklfow action instance", "required": true, "schema": { "type": "string", "x-go-name": "WFActionInstanceID" }, "x-go-name": "WFActionInstanceID" }, { "name": "iteration", "in": "query", "description": "Iteration number for block instance if it has blocks", "schema": { "type": "integer", "format": "uint64", "x-go-name": "Iteration" }, "x-go-name": "Iteration" } ], "responses": { "200": { "description": "An WorkflowActionInstanceResponse response model\n\n# This is used for returning a response of action instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionInstanceGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/instances/{wf_instance_id}/cancel": { "post": { "tags": [ "WorkflowInstances" ], "summary": "# Handler to cancel a specific workflow instance", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have RUN permission to given workflow", "operationId": "CancelWFInstanceByID", "parameters": [ { "name": "wf_instance_id", "in": "path", "description": "The Id of worklfow instance", "required": true, "schema": { "type": "string", "x-go-name": "WFInstanceID" }, "x-go-name": "WFInstanceID" } ], "responses": { "200": { "description": "An CancelInstanceGetResponse response model\n\n# Return cancel instance operation status", "headers": { "status": { "schema": { "type": "string" } } }, "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/metadata/refreshtoken": { "post": { "summary": "Handler to refreshtoken if not available.", "description": "Allowed Role(s): admin, user", "operationId": "RefreshToken", "responses": { "201": { "description": "MetaDataRefreshTokenResponse response model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataRefreshToken" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/ratelimits/events": { "get": { "tags": [ "EventsRateLimit" ], "summary": "Handler to return EventsRateLimit information.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getEventsRateLimit", "responses": { "200": { "description": "eventsRateLimitGetResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eventsRateLimitGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/ratings": { "post": { "tags": [ "Ratings" ], "summary": "Create rating.", "description": "This endpoint allows users to add a rating.", "operationId": "ratingCreateRequest", "requestBody": { "description": "The rating to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "A GetRatingResponse response model\n\n# This is used for returning a response of rating as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/ratings/loginuser": { "post": { "tags": [ "Ratings" ], "summary": "Handler to get rating for logged in user.", "description": "Allowed Role(s): admin, user, sat", "operationId": "ratingLoginUserPostRequest", "requestBody": { "description": "The request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingLoginUserRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A GetRatingResponse response model\n\n# This is used for returning a response of rating as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/ratings/{rating_id}": { "put": { "tags": [ "Ratings" ], "summary": "Handler to update rating object's information using rating ID.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast MODIFY permission for rating", "operationId": "readRatingByIDParams", "parameters": [ { "name": "rating_id", "in": "path", "description": "The ratingID of rating", "required": true, "schema": { "type": "string", "x-go-name": "RatingID" }, "x-go-name": "RatingID" } ], "requestBody": { "description": "The rating of xchange", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A GetRatingResponse response model\n\n# This is used for returning a response of rating as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/references/{reference_id}": { "get": { "tags": [ "References" ], "summary": "# ReadReferences Handler to return information about references", "description": "Allowed Role(s): admin, user, sat", "operationId": "referenceRequest", "parameters": [ { "name": "reference_id", "in": "path", "description": "Reference ID", "required": true, "schema": { "type": "string", "x-go-name": "ReferenceID" }, "x-go-name": "ReferenceID" }, { "name": "base_type", "in": "query", "description": "Reference ID's base type", "required": true, "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType" }, { "name": "uses", "in": "query", "description": "Return references which object uses", "schema": { "type": "boolean", "x-go-name": "Uses" }, "x-go-name": "Uses" }, { "name": "used_by", "in": "query", "description": "Return references in which object are used by", "schema": { "type": "boolean", "x-go-name": "UsedBy" }, "x-go-name": "UsedBy" } ], "responses": { "200": { "description": "ReferenceResponse response model\n\nThis is used for returning a response with uses and/or usedby", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllReferences" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/remotes": { "get": { "tags": [ "RemoteMeta" ], "summary": "# Handler to get all remotemeta information", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllRemoteMeta", "responses": { "200": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "RemoteMeta" ], "summary": "# Handler to create a remotemeta", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create an RemoteMeta.", "operationId": "RemoteMetaCreateRequest", "requestBody": { "description": "The remotemeta to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/remotes/{remote_meta_id}": { "get": { "tags": [ "RemoteMeta" ], "summary": "getRemoteMetaByID Handler to return remotemeta information.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getRemoteMetaByID", "parameters": [ { "name": "remote_meta_id", "in": "path", "description": "An ID or UniqueName of remotemeta", "required": true, "schema": { "type": "string", "x-go-name": "RemoteMetaID" }, "x-go-name": "RemoteMetaID" } ], "responses": { "200": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "RemoteMeta" ], "summary": "# Handler to update remotemeta", "description": "Allowed Role(s): admin", "operationId": "RemoteMetaUpdateRequest", "parameters": [ { "name": "remote_meta_id", "in": "path", "description": "The remotemetaID of RemoteMeta", "required": true, "schema": { "type": "string", "x-go-name": "RemoteMetaID" }, "x-go-name": "RemoteMetaID" } ], "requestBody": { "description": "The remotemeta to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "RemoteMeta" ], "summary": "# Handler to delete remotemeta", "description": "Allowed Role(s): admin", "operationId": "deleteRemoteMetaByID", "parameters": [ { "name": "remote_meta_id", "in": "path", "description": "An ID of remotemeta", "required": true, "schema": { "type": "string", "x-go-name": "RemoteMetaID" }, "x-go-name": "RemoteMetaID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/remotes/{remote_meta_id}/": { "post": { "tags": [ "RemoteMeta" ], "summary": "# Handler to manage remotemeta package", "description": "Allowed Role(s): admin", "operationId": "RemoteMetaConfigRequest", "parameters": [ { "name": "remote_meta_id", "in": "path", "description": "The remotemetaID of RemoteMeta", "required": true, "schema": { "type": "string", "x-go-name": "RemoteMetaID" }, "x-go-name": "RemoteMetaID" }, { "name": "action", "in": "query", "description": "The action for RemoteMeta config\nExpected actions are \"generate\" and \"revoke\"", "required": true, "schema": { "type": "string", "x-go-name": "Action" }, "x-go-name": "Action" } ], "responses": { "200": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/rules": { "post": { "tags": [ "Rules" ], "summary": "# Handler to create a rule", "description": "Allowed Role(s): admin, user", "operationId": "RuleCreateRequest", "requestBody": { "description": "The rule to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An RuleResponse response model\n\n# This is used for returning a response with a single rule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/rules/batch_get": { "post": { "tags": [ "Rules" ], "summary": "Handler to get all rules.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllRulesQueryParam", "parameters": [ { "name": "search", "in": "query", "description": "Comma separated list of search terms to filter based on rule names", "schema": { "type": "string", "x-go-name": "Search" }, "x-go-name": "Search" }, { "name": "state", "in": "query", "description": "Comma separated list of rule states to filter", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "limit", "in": "query", "description": "Number of rules to return for this request", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of rules from n'th rule, n is start to be provided", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Return list of rules in sorted order", "schema": { "type": "string", "x-go-name": "SortBy" }, "x-go-name": "SortBy" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesPostRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An GetAllRulesSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllRulesPaginatedResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/rules/priority": { "patch": { "tags": [ "Rules" ], "summary": "# Handler to update a rule", "description": "Allowed Role(s): admin", "operationId": "rulePriorityOrderRequest", "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePatchRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An RuleResponse response model\n\n# This is used for returning a response with a single rule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/rules/{rule_id}": { "get": { "tags": [ "Rules" ], "summary": "# Handler to get rule by ID.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getRuleRequest", "parameters": [ { "name": "rule_id", "in": "path", "description": "The ID of Rule", "required": true, "schema": { "type": "string", "x-go-name": "RuleID" }, "x-go-name": "RuleID" } ], "responses": { "200": { "description": "An GetRuleResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllRuleResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Rules" ], "summary": "# Handler to update a rule", "description": "Allowed Role(s): admin", "operationId": "RuleUpdateRequest", "parameters": [ { "name": "rule_id", "in": "path", "description": "The ruleID of Rule", "required": true, "schema": { "type": "string", "x-go-name": "RuleID" }, "x-go-name": "RuleID" } ], "requestBody": { "description": "The rule to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulePutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An RuleResponse response model\n\n# This is used for returning a response with a single rule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Rules" ], "summary": "# Handler to delete rule", "description": "Allowed Role(s): admin", "operationId": "DeleteRuleByID", "parameters": [ { "name": "rule_id", "in": "path", "description": "An ruleID of rule", "required": true, "schema": { "type": "string", "x-go-name": "RuleID" }, "x-go-name": "RuleID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/runtime_users": { "get": { "tags": [ "RuntimeUsers" ], "summary": "Handler to get all runtimeusers.", "description": "Allowed Role(s): admin, user, sat", "operationId": "listRuntimeUsers", "parameters": [ { "name": "types", "in": "query", "description": "Type of Runtime user.", "schema": { "type": "string", "x-go-name": "Types" }, "x-go-name": "Types" } ], "responses": { "200": { "description": "RuntimeUserResponse response model\n\n# This is used for returning a response with a single runtime user as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "RuntimeUsers" ], "summary": "Handler to create a runtimeuser.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Runtime User.", "operationId": "runtimeUserCreateRequest", "requestBody": { "description": "The runtime user to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "RuntimeUserDefinitonResponse response model\n\n# This is used for returning a response with a single runtime user as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/runtime_users/{runtime_user_id}": { "get": { "tags": [ "RuntimeUsers" ], "summary": "readRuntimeUserByID Handler to return information about runtime user.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getRuntimeUserById", "parameters": [ { "name": "runtime_user_id", "in": "path", "description": "The definitionId of runtimeuser", "required": true, "schema": { "type": "string", "x-go-name": "RuntimeUserID" }, "x-go-name": "RuntimeUserID" } ], "responses": { "200": { "description": "RuntimeUserDefinitonResponse response model\n\n# This is used for returning a response with a single runtime user as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "delete": { "tags": [ "RuntimeUsers" ], "summary": "deleteRuntimeUser Handler to delete runtime user using definition ID.", "description": "Allowed Role(s): admin", "operationId": "deleteRuntimeUserById", "parameters": [ { "name": "runtime_user_id", "in": "path", "description": "The definitionId of runtimeuser", "required": true, "schema": { "type": "string", "x-go-name": "RuntimeUserID" }, "x-go-name": "RuntimeUserID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "patch": { "tags": [ "RuntimeUsers" ], "summary": "updateRuntimeUser Handler to update runtime user.", "description": "Allowed Role(s): admin", "operationId": "runtimeUserUpdateRequest", "parameters": [ { "name": "runtime_user_id", "in": "path", "description": "he definitionId of runtimeuser", "required": true, "schema": { "type": "string", "x-go-name": "RuntimeUserID" }, "x-go-name": "RuntimeUserID" } ], "requestBody": { "description": "The runtime user to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionPatchRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "RuntimeUserDefinitonResponse response model\n\n# This is used for returning a response with a single runtime user as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/schedules": { "get": { "tags": [ "Schedules" ], "summary": "Handler to get all schedules.", "description": "Allowed Role(s): admin, user, sat", "operationId": "listSchedules", "responses": { "200": { "description": "An ScheduleResponse response model\n\n# This is used for returning a response with a single schedule as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Schedules" ], "summary": "Handler to creates a schedule.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Schedule.", "operationId": "scheduleCreateRequest", "requestBody": { "description": "The schedule to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleDefinitionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An ScheduleDefinitonResponse response model\n\n# This is used for returning a response of schedule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/schedules/{schedule_id}": { "get": { "tags": [ "Schedules" ], "summary": "Handler to get a specific schedule.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getScheduleById", "parameters": [ { "name": "schedule_id", "in": "path", "description": "The definitionId of schedule", "required": true, "schema": { "type": "string", "x-go-name": "ScheduleID" }, "x-go-name": "ScheduleID" } ], "responses": { "200": { "description": "An ScheduleDefinitonResponse response model\n\n# This is used for returning a response of schedule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Schedules" ], "summary": "Handler to updates a schedule. Allows partial update.", "description": "Allowed Role(s): admin", "operationId": "scheduleUpdateRequest", "parameters": [ { "name": "schedule_id", "in": "path", "description": "The definitionId of schedule", "required": true, "schema": { "type": "string", "x-go-name": "ScheduleID" }, "x-go-name": "ScheduleID" } ], "requestBody": { "description": "The schedule to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ScheduleDefinitonResponse response model\n\n# This is used for returning a response of schedule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Schedules" ], "summary": "Handler to delete a schedule.", "description": "Allowed Role(s): admin", "operationId": "deleteScheduleById", "parameters": [ { "name": "schedule_id", "in": "path", "description": "The definitionId of schedule", "required": true, "schema": { "type": "string", "x-go-name": "ScheduleID" }, "x-go-name": "ScheduleID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/schemas": { "get": { "tags": [ "Schemas" ], "summary": "Handler returning information about all Schemas.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllSchemaQueryParams", "parameters": [ { "name": "base_type", "in": "query", "description": "Base type of Schema.", "required": true, "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType" }, { "name": "schema_type", "in": "query", "description": "Type of Schema.", "required": true, "schema": { "type": "string", "x-go-name": "SchemaType" }, "x-go-name": "SchemaType" }, { "name": "detailed", "in": "query", "description": "detailed Schema.", "schema": { "type": "boolean", "x-go-name": "Detailed" }, "x-go-name": "Detailed" }, { "name": "variable_type", "in": "query", "description": "variable_type of data_type schema.", "schema": { "type": "boolean", "x-go-name": "VariableType" }, "x-go-name": "VariableType" }, { "name": "is_internal", "in": "query", "description": "internal Schemas.", "schema": { "type": "boolean", "x-go-name": "IsInternal" }, "x-go-name": "IsInternal" } ], "responses": { "200": { "description": "An GetSchemaAllResponse response model\n\n# This is used for returning a response of schema as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Schema" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Schemas" ], "summary": "Handler to create a schema template for all base_types.", "description": "Allowed Role(s): admin", "operationId": "schemaCreateRequest", "requestBody": { "description": "The schema to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaNewPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An SchemaPostResponse response model\n\n# This is used for returning a response of schema as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaNewPostResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/schemas/{type_or_id}": { "get": { "tags": [ "Schemas" ], "summary": "Handler returning information about Template.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getSchemaById", "parameters": [ { "name": "type_or_id", "in": "path", "description": "The type or Id of Schema", "required": true, "schema": { "type": "string", "x-go-name": "TypeORID" }, "x-go-name": "TypeORID" }, { "name": "schema_type", "in": "query", "description": "Type of Schema. It can be \"data\" or \"view\".", "schema": { "type": "string", "x-go-name": "SchemaType" }, "x-go-name": "SchemaType" } ], "responses": { "200": { "description": "An GetDataViewSchemaResponse response model\n\n# This is used for returning a response of both data and view schema as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaByTypeResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Schemas" ], "summary": "handler method for updating adapter template/schema.", "description": "Allowed Role(s): admin", "operationId": "schemaUpdateRequest", "parameters": [ { "name": "type_or_id", "in": "path", "description": "The type or id of schema", "required": true, "schema": { "type": "string", "x-go-name": "TypeORID" }, "x-go-name": "TypeORID" } ], "requestBody": { "description": "The schema to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An GetSchemaResponse response model\n\n# This is used for returning a response of schema as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schema" } } } }, "312": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Schemas" ], "summary": "Handler for delete Schema.", "description": "Allowed Role(s): admin", "operationId": "deleteSchemaById", "parameters": [ { "name": "type_or_id", "in": "path", "description": "The type or Id of Schema", "required": true, "schema": { "type": "string", "x-go-name": "TypeORID" }, "x-go-name": "TypeORID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/share/{entity_id}": { "get": { "tags": [ "ShareObjectPermissions" ], "summary": "# Handler to get all object permission for entityID", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have MANAGE permission to given enitiy", "operationId": "ReadObjectSharePermissions", "parameters": [ { "name": "entity_id", "in": "path", "description": "An ID of entity (i.e workflow ID)", "required": true, "schema": { "type": "string", "x-go-name": "EntityID" }, "x-go-name": "EntityID" }, { "name": "base_type", "in": "query", "description": "Entity base type (The supported entitiy is only \"workflow\" for now)", "required": true, "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType" } ], "responses": { "200": { "description": "An ShareObjectPermissionsResponse response model\n\n# This is used for returning a response for sharing of object permissions for user and groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "ShareObjectPermissions" ], "summary": "# ShareObjectPermissions Handler to update object permissions of users and groups", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have MANAGE permission to given enitiy", "operationId": "UpdateObjectSharePermissions", "parameters": [ { "name": "entity_id", "in": "path", "description": "An ID of entity (i.e workflow ID)", "required": true, "schema": { "type": "string", "x-go-name": "EntityID" }, "x-go-name": "EntityID" }, { "name": "base_type", "in": "query", "description": "Entity base type (The supported entitiy is only \"workflow\" for now)", "required": true, "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType" } ], "requestBody": { "description": "Share update object permissions payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ShareObjectPermissionsResponse response model\n\n# This is used for returning a response for sharing of object permissions for user and groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "post": { "tags": [ "ShareObjectPermissions" ], "summary": "# Handler to share object permissions to users and groups", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have MANAGE permission to given enitiy", "operationId": "CreateObjectSharePermissions", "parameters": [ { "name": "entity_id", "in": "path", "description": "An ID of entity (i.e workflow ID)", "required": true, "schema": { "type": "string", "x-go-name": "EntityID" }, "x-go-name": "EntityID" }, { "name": "base_type", "in": "query", "description": "Entity base type (The supported entitiy is only \"workflow\" for now)", "required": true, "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType" } ], "requestBody": { "description": "The object permissions payload to share.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An ShareObjectPermissionsResponse response model\n\n# This is used for returning a response for sharing of object permissions for user and groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/sx/sxo-events": { "post": { "tags": [ "SXIROHIncident" ], "summary": "# Handler to handle SX IROH Incident", "description": "Allowed Role(s): admin, user", "operationId": "SXIROHIncidentPostRequest", "responses": { "200": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/table_types": { "get": { "tags": [ "TableTypes" ], "summary": "# Handler to return get all table types", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllTableType", "responses": { "200": { "description": "A TableTypeGetAllResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTableTypeGetResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "TableTypes" ], "summary": "Handler to create Table Type.", "description": "Allowed Role(s): admin", "operationId": "tableTypeCreateRequest", "requestBody": { "description": "The request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tableTypePostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "A TableTypeGetResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTableTypeGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/table_types/{table_type_id}": { "get": { "tags": [ "TableTypes" ], "summary": "Handler to return Table type's information using ID.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getTableTypeById", "parameters": [ { "name": "table_type_id", "in": "path", "description": "The Table Type ID", "required": true, "schema": { "type": "string", "x-go-name": "TableTypeID" }, "x-go-name": "TableTypeID" } ], "responses": { "200": { "description": "A TableTypeSchemaGetResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableTypeSchemaResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "TableTypes" ], "summary": "Handler to Update Table Type.", "description": "Allowed Role(s): admin", "operationId": "tableTypePutRequest", "parameters": [ { "name": "table_type_id", "in": "path", "description": "The request to submit.", "required": true, "schema": { "type": "string", "x-go-name": "TableTypeID" }, "x-go-name": "TableTypeID" } ], "requestBody": { "description": "The request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tableTypePostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A TableTypeGetResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTableTypeGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "TableTypes" ], "summary": "Handler to delete Table type using ID.", "description": "Allowed Role(s): admin", "operationId": "delTableTypeById", "parameters": [ { "name": "table_type_id", "in": "path", "description": "The Table Type ID", "required": true, "schema": { "type": "string", "x-go-name": "TableTypeID" }, "x-go-name": "TableTypeID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tables/{table_id}": { "get": { "tags": [ "Tables" ], "summary": "Handler to retrieve table rows.", "description": "Allowed Role(s): admin, user, sat", "operationId": "tableGetRowsReqParams", "parameters": [ { "name": "table_id", "in": "path", "description": "The Table ID", "required": true, "schema": { "type": "string", "x-go-name": "TableID" }, "x-go-name": "TableID" }, { "name": "offset", "in": "query", "description": "Offset - number of rows to skip", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Offset" }, "x-go-name": "Offset" }, { "name": "rows", "in": "query", "description": "Rows - number of rows to return", "required": true, "schema": { "type": "integer", "format": "int64", "x-go-name": "Rows" }, "x-go-name": "Rows" }, { "name": "workflow_id", "in": "query", "description": "Workflow ID if the table is a workflow table", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "workflow_instance_id", "in": "query", "description": "Workflow instance ID if the table is a workflow instance table", "schema": { "type": "string", "x-go-name": "WorkflowInstanceID" }, "x-go-name": "WorkflowInstanceID" }, { "name": "scope", "in": "query", "description": "variable scope for this Table", "schema": { "type": "string", "x-go-name": "Scope" }, "x-go-name": "Scope" } ], "responses": { "200": { "description": "A TableResponse model\n\n# This is used for returning a response of Table as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/target_groups": { "get": { "tags": [ "TargetGroups" ], "summary": "# Handler returning all Target groups information", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllTargetGroups", "responses": { "200": { "description": "The TargetGroupAllResponse response model\n\n# This is used for returning a response of target group as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/targetGroupGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "TargetGroups" ], "summary": "Handler to create Target group.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Target Group.", "operationId": "targetGroupCreateRequest", "requestBody": { "description": "The target group to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetGroupRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An TargetGroupResponse response model\n\n# This is used for returning a response for target group as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/targetGroupGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/target_groups/{target_group_id}": { "get": { "tags": [ "TargetGroups" ], "summary": "readTargetGroupByID Handler to return Target group infomration.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getTargetGroupById", "parameters": [ { "name": "target_group_id", "in": "path", "description": "An ID of target_group", "required": true, "schema": { "type": "string", "x-go-name": "TargetGroupID" }, "x-go-name": "TargetGroupID" } ], "responses": { "200": { "description": "An TargetGroupResponse response model\n\n# This is used for returning a response for target group as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/targetGroupGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "TargetGroups" ], "summary": "# UpdateTarget Handler to update the target group", "description": "Allowed Role(s): admin", "operationId": "targetGroupUpdateRequest", "parameters": [ { "name": "target_group_id", "in": "path", "description": "The definitionId of target group", "required": true, "schema": { "type": "string", "x-go-name": "TargetGroupID" }, "x-go-name": "TargetGroupID" } ], "requestBody": { "description": "The target group to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetGroupRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An TargetGroupResponse response model\n\n# This is used for returning a response for target group as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/targetGroupGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "TargetGroups" ], "summary": "# Handler to delete Target group", "description": "Allowed Role(s): admin", "operationId": "deleteTargetGroupByID", "parameters": [ { "name": "target_group_id", "in": "path", "description": "An ID of target_group", "required": true, "schema": { "type": "string", "x-go-name": "TargetGroupID" }, "x-go-name": "TargetGroupID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/targets": { "get": { "tags": [ "Targets" ], "summary": "Handler returning all Targets.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllTargetQueryParams", "parameters": [ { "name": "is_internal", "in": "query", "description": "internal Schemas.", "schema": { "type": "boolean", "x-go-name": "IsInternal" }, "x-go-name": "IsInternal" }, { "name": "types", "in": "query", "description": "Types of Targets, comma separated list if getting more than one type.", "schema": { "type": "string", "x-go-name": "Types" }, "x-go-name": "Types" } ], "responses": { "200": { "description": "The TargetDefinitonAllResponse response model\n\n# This is used for returning a response of Targets as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetDefinitionGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Targets" ], "summary": "Handler to create a Target.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Target.", "operationId": "targetCreateRequest", "requestBody": { "description": "The target to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "The TargetDefinitonResponse response model\n\n# This is used for returning a response of Target as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/targets/validate": { "post": { "tags": [ "Targets" ], "summary": "validateTargets Handler to perform target validations", "description": "Allowed Role(s): admin", "operationId": "targetValidateRequest", "parameters": [ { "name": "all", "in": "query", "description": "if true, it validates all targets in the system. Will ignore the request body.\nif false, request_body is required and target validation is performed on specific target_ids specified in the body", "schema": { "type": "boolean", "x-go-name": "AllTargets" }, "x-go-name": "AllTargets" } ], "requestBody": { "description": "The target to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetIDsRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "targetValidationResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/targetValidationResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/targets/{target_id}": { "get": { "tags": [ "Targets" ], "summary": "ReadTargetByID Handler to return Target information.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getTargetById", "parameters": [ { "name": "target_id", "in": "path", "description": "The definitionId of target", "required": true, "schema": { "type": "string", "x-go-name": "TargetID" }, "x-go-name": "TargetID" } ], "responses": { "200": { "description": "The TargetDefinitonResponse response model\n\n# This is used for returning a response of Target as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Targets" ], "summary": "updateTarget Handler to update the target.", "description": "Allowed Role(s): admin", "operationId": "targetUpdateRequest", "parameters": [ { "name": "target_id", "in": "path", "description": "The definitionId of target", "required": true, "schema": { "type": "string", "x-go-name": "TargetID" }, "x-go-name": "TargetID" } ], "requestBody": { "description": "The target to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "The TargetDefinitonResponse response model\n\n# This is used for returning a response of Target as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Targets" ], "summary": "deleteTarget handler for delete Target byId.", "description": "Allowed Role(s): admin", "operationId": "deleteTargetById", "parameters": [ { "name": "target_id", "in": "path", "description": "The definitionId of target", "required": true, "schema": { "type": "string", "x-go-name": "TargetID" }, "x-go-name": "TargetID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Handler to get all tasks.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllTasksQueryParam", "parameters": [ { "name": "owner", "in": "query", "description": "Comma separated list of owner IDs to filter by", "schema": { "type": "string", "x-go-name": "Owner" }, "x-go-name": "Owner" }, { "name": "search", "in": "query", "description": "Comma separated list of search terms to filter based on task display names, and task response", "schema": { "type": "string", "x-go-name": "Search" }, "x-go-name": "Search" }, { "name": "state", "in": "query", "description": "Comma separated list of task states to filter", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" }, { "name": "limit", "in": "query", "description": "Number of tasks to return for this request", "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of tasks from n'th task, n is start to be provided", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Comma separated list of task priorities to filter", "schema": { "type": "string", "x-go-name": "Priority" }, "x-go-name": "Priority" }, { "name": "due_date", "in": "query", "description": "filter tasks based on due date, an valid date will be 2019-05-15T12:00:00Z", "schema": { "type": "string", "x-go-name": "DueDate" }, "x-go-name": "DueDate" }, { "name": "requestor", "in": "query", "description": "Comma separated list of task requestors to filter", "schema": { "type": "string", "x-go-name": "Requestor" }, "x-go-name": "Requestor" }, { "name": "assignees", "in": "query", "description": "Comma separated list of task assignees to filter", "schema": { "type": "string", "x-go-name": "Assignees" }, "x-go-name": "Assignees" }, { "name": "response", "in": "query", "description": "Comma separated list of responses that assignees has responded", "schema": { "type": "string", "x-go-name": "Response" }, "x-go-name": "Response" }, { "name": "type", "in": "query", "description": "Filter based on type of task", "schema": { "type": "string", "x-go-name": "TaskType" }, "x-go-name": "TaskType" } ], "responses": { "200": { "description": "An GetAllTasksSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllTasksResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tasks/batch_get": { "get": { "tags": [ "Tasks" ], "summary": "Handler to get tasks in batch.", "description": "Allowed Role(s): admin, user, sat", "operationId": "getAllTasksInBatch", "responses": { "200": { "description": "An GetAllTasksSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllTasksResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tasks/summary": { "get": { "tags": [ "Tasks" ], "summary": "Handler to get a summary of tasks.", "description": "Including total number of tasks, not completed, due soon, overdue, expired and assigned to the user.\nAllowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given task", "operationId": "listTaskSummary", "responses": { "200": { "description": "An GetTasksSummaryResponse model.\n\n# It will return a summary of tasks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TasksSummaryResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tasks/{task_id}": { "get": { "tags": [ "Tasks" ], "summary": "Handler to get a specific task.", "description": "Allowed Role(s): admin, user, sat", "operationId": "readTaskRequest", "parameters": [ { "name": "task_id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "string", "x-go-name": "TaskID" }, "x-go-name": "TaskID" } ], "responses": { "200": { "description": "An ReadTaskResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaskResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "patch": { "tags": [ "Tasks" ], "summary": "Handler to update a task.", "description": "Allowed Role(s): admin, user", "operationId": "taskPatchRequest", "parameters": [ { "name": "task_id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "string", "x-go-name": "TaskID" }, "x-go-name": "TaskID" } ], "requestBody": { "description": "Task request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPatchRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ReadTaskResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaskResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/tasks/{task_id}/action": { "post": { "tags": [ "Tasks" ], "summary": "Handler for an assignee of a task to take action on the task.", "description": "Allowed Role(s): admin, user", "operationId": "taskActionRequest", "parameters": [ { "name": "task_id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "string", "x-go-name": "TaskID" }, "x-go-name": "TaskID" } ], "requestBody": { "description": "Task action to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TakeActionRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ReadTaskResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaskResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/tenants": { "get": { "tags": [ "Tenants" ], "summary": "Handler returning tenant and its sub tenants.", "description": "Allowed Role(s): admin", "operationId": "getAllTenants", "responses": { "200": { "description": "An TenantGetAllResponse response model\n\n# This is used for returning a response of Tenant and Its sub tenants as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } } } }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/tenants/{tenant_id}": { "get": { "tags": [ "Tenants" ], "summary": "ReadTenantByID Handler to return tenant infomration.", "description": "Allowed Role(s): admin", "operationId": "getTenantById", "parameters": [ { "name": "tenant_id", "in": "path", "description": "The id of tenant", "required": true, "schema": { "type": "string", "x-go-name": "TenantID" }, "x-go-name": "TenantID" } ], "responses": { "200": { "description": "The TenantResponse response model\n\n# This is used for returning a response of Tenant as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Tenants" ], "summary": "Handler to update a Tenant.", "description": "Allowed Role(s): admin", "operationId": "tenantUpdateRequest", "parameters": [ { "name": "tenant_id", "in": "path", "description": "The id of Tenant", "required": true, "schema": { "type": "string", "x-go-name": "TenantID" }, "x-go-name": "TenantID" } ], "requestBody": { "description": "The tenant to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "The TenantResponse response model\n\n# This is used for returning a response of Tenant as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/update_table/{table_id}": { "post": { "tags": [ "Tables" ], "summary": "Handler to update/add/delete rows", "description": "Allowed Role(s): admin", "operationId": "tableUpdateRowPostRequest", "parameters": [ { "name": "table_id", "in": "path", "description": "The Table ID", "required": true, "schema": { "type": "string", "x-go-name": "TableID" }, "x-go-name": "TableID" }, { "name": "workflow_id", "in": "query", "description": "Workflow ID if the table is a workflow table", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "rows for add/update/delete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTableRowPostRequest" } } }, "required": true, "x-go-name": "UpdateRowRequest" }, "responses": { "200": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "rows" } }, "/v1/variable_types": { "post": { "tags": [ "VariableTypes" ], "summary": "Create a Variable Type.", "description": "This endpoint allows an admin user to create a new Variable type.", "operationId": "VariableTypeCreateRequest", "requestBody": { "description": "The request body for creating the variable type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableTypePostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "VariableTypeAPIResponse VariableType response model\n\nThis is used for returning a response of Variable Type as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variableTypeResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/variable_types/batch_get": { "post": { "tags": [ "VariableTypes" ], "summary": "Handler to get all VariableTypes.", "operationId": "getAllVarTypesRequest", "parameters": [ { "name": "limit", "in": "query", "description": "Number of variable types to return for this request", "schema": { "type": "integer", "format": "int64", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "start", "in": "query", "description": "Return list of variable types from n'th variable types", "schema": { "type": "integer", "format": "int64", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "sort_by", "in": "query", "description": "Return list of variable types in sorted order (created_on/updated_on)", "schema": { "type": "string", "x-go-name": "SortBy" }, "x-go-name": "SortBy" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllVarTypesPostRequest" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A GetAllVarTypesSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllVariableTypesResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/variable_types/{variable_type_id}": { "get": { "tags": [ "VariableTypes" ], "summary": "Get a Variable Type.", "description": "This endpoint allows an admin user to fetch a Variable type.", "operationId": "ReadVariableTypeRequest", "parameters": [ { "name": "variable_type_id", "in": "path", "description": "The ID of variable type to get", "required": true, "schema": { "type": "string", "x-go-name": "VariableTypeID" }, "x-go-name": "VariableTypeID" } ], "responses": { "200": { "description": "variableTypeGetResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variableTypeGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "VariableTypes" ], "summary": "Update a Variable Type.", "description": "This endpoint allows an admin user to update a Variable type.", "operationId": "VariableTypeUpdateRequest", "parameters": [ { "name": "variable_type_id", "in": "path", "description": "The ID of variable type to update.", "required": true, "schema": { "type": "string", "x-go-name": "VariableTypeID" }, "x-go-name": "VariableTypeID" } ], "requestBody": { "description": "The payload for updating the variable type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableTypePutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "VariableTypeAPIResponse VariableType response model\n\nThis is used for returning a response of Variable Type as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variableTypeResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "VariableTypes" ], "summary": "Delete a Variable Type.", "description": "This endpoint allows an admin user to delete a Variable type.", "operationId": "DeleteVariableTypeRequest", "parameters": [ { "name": "variable_type_id", "in": "path", "description": "The ID of variable type to delete.", "required": true, "schema": { "type": "string", "x-go-name": "VariableTypeID" }, "x-go-name": "VariableTypeID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/variables": { "get": { "tags": [ "Variables" ], "summary": "Handler to get all Variables.", "description": "Allowed Role(s) for Global variables: admin\nAllowed Role(s) for ENV variables: admin, user, sat", "operationId": "listVariables", "responses": { "200": { "description": "An VariableResponse response model\n\nThis is used for returning a response with a single variable as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Variables" ], "summary": "Handler to create a Variable.", "description": "Allowed Role(s) for Global variables: admin\nAllowed Role(s) for ENV variables: admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Variable.", "operationId": "variableCreateRequest", "requestBody": { "description": "Variable request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariablePostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "VariableDefinitonResponse An VariableDefinitonResponse response model\n\nThis is used for returning a response of Variable as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/variables/{variable_id}": { "get": { "tags": [ "Variables" ], "summary": "Handler to return information about Variable.", "description": "Allowed Role(s) for Global variables: admin, user, sat\nAllowed Role(s) for ENV variables: admin, user, sat", "operationId": "getVariableById", "parameters": [ { "name": "variable_id", "in": "path", "description": "Variable ID", "required": true, "schema": { "type": "string", "x-go-name": "VariableID" }, "x-go-name": "VariableID" } ], "responses": { "200": { "description": "VariableDefinitonResponse An VariableDefinitonResponse response model\n\nThis is used for returning a response of Variable as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Variables" ], "summary": "Handler to update Variable.", "description": "Allowed Role(s) for Global variables: admin\nAllowed Role(s) for ENV variables: admin", "operationId": "VariableUpdateRequest", "parameters": [ { "name": "variable_id", "in": "path", "description": "Variable ID", "required": true, "schema": { "type": "string", "x-go-name": "VariableID" }, "x-go-name": "VariableID" } ], "requestBody": { "description": "Variable request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariablePutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "VariableDefinitonResponse An VariableDefinitonResponse response model\n\nThis is used for returning a response of Variable as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Variables" ], "summary": "Handler to delete Variable byId.", "description": "Allowed Role(s) for Global variables: admin\nAllowed Role(s) for ENV variables: admin", "operationId": "deleteVariableById", "parameters": [ { "name": "variable_id", "in": "path", "description": "Variable ID", "required": true, "schema": { "type": "string", "x-go-name": "VariableID" }, "x-go-name": "VariableID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/variables/{variable_id}/references": { "get": { "tags": [ "Variables" ], "summary": "# Handler to return Variable References by Variable Id", "description": "Allowed Role(s) for Global variables: admin, user, sat\nAllowed Role(s) for ENV variables: admin, user, sat", "operationId": "getVariableRefeById", "parameters": [ { "name": "variable_id", "in": "path", "description": "Variable ID", "required": true, "schema": { "type": "string", "x-go-name": "VariableID" }, "x-go-name": "VariableID" } ], "responses": { "200": { "description": "VariableDefinitonResponse An VariableDefinitonResponse response model\n\nThis is used for returning a response of Variable as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "# Handler to get all webhooks information", "description": "Allowed Role(s): admin, user, sat", "operationId": "GetAllWebhooks", "responses": { "200": { "description": "An WebhooksResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Webhooks" ], "summary": "# Handler to create a webhook", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create an Webhook.", "operationId": "WebhookCreateRequest", "requestBody": { "description": "The webhook to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An WebhookResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/webhooks/{webhook_id}": { "get": { "tags": [ "Webhooks" ], "summary": "readWebhookByID Handler to return Webhook information.", "description": "Allowed Role(s): admin, user, sat", "operationId": "readWebhookByID", "parameters": [ { "name": "webhook_id", "in": "path", "description": "An ID of webhook", "required": true, "schema": { "type": "string", "x-go-name": "WebhookID" }, "x-go-name": "WebhookID" } ], "responses": { "200": { "description": "An WebhookResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Webhooks" ], "summary": "# Handler to update webhook", "description": "Allowed Role(s): admin", "operationId": "WebhookUpdateRequest", "parameters": [ { "name": "webhook_id", "in": "path", "description": "The webhookID of Webhook", "required": true, "schema": { "type": "string", "x-go-name": "WebhookID" }, "x-go-name": "WebhookID" } ], "requestBody": { "description": "The webhook to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An WebhookResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Webhooks" ], "summary": "# Handler to delete webhook", "description": "Allowed Role(s): admin", "operationId": "deleteWebhookByID", "parameters": [ { "name": "webhook_id", "in": "path", "description": "An ID of webhook", "required": true, "schema": { "type": "string", "x-go-name": "WebhookID" }, "x-go-name": "WebhookID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/webhooks/{webhook_id}/refresh_api_key": { "post": { "tags": [ "Webhooks" ], "summary": "Handler to refresh api_key for webhook", "description": "Allowed Role(s): admin", "operationId": "WebhookRefreshAPIKeyRequest", "parameters": [ { "name": "webhook_id", "in": "path", "description": "The webhookID of Webhook", "required": true, "schema": { "type": "string", "x-go-name": "WebhookID" }, "x-go-name": "WebhookID" } ], "responses": { "200": { "description": "An WebhookResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Handler to get all workflows.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getAllWorkflowsQueryParamsV1", "parameters": [ { "name": "is_atomic", "in": "query", "description": "Provide true if you need only atomic workflows.", "schema": { "type": "boolean", "x-go-name": "IsAtomic" }, "x-go-name": "IsAtomic" }, { "name": "categories", "in": "query", "description": "Comma separated list of category names to search for.", "schema": { "type": "string", "x-go-name": "Categories" }, "x-go-name": "Categories" } ], "responses": { "200": { "description": "An WorkflowResponseV1 response model\n\n# This is used for returning a response with a single workflow as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Workflows" ], "summary": "Handler to create a workflow definition.", "description": "Allowed Role(s): admin\n\nEither ViewSchemaID or Type or both in request body can be provided to create a Workflow.", "operationId": "workflowCreateRequest", "requestBody": { "description": "The request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "A WorkflowDefinitonResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/batch_get": { "post": { "tags": [ "Workflows" ], "summary": "# Handler to retrieve a list of workflows", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have view permission to the given list of workflows", "operationId": "workflowBatchGetPostRequest", "requestBody": { "description": "List of workflows to retrieve", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An WorkflowBatchGetResponse response model\n\n# This is used for returning a response of list of workflows as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionGetAllResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/start": { "post": { "tags": [ "Workflows" ], "summary": "Handler to start workflow execution.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have RUN permission to given workflow", "operationId": "startWorkflowRequest", "parameters": [ { "name": "workflow_id", "in": "query", "description": "ID of the workflow, to start workflow using id. (Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "unique_name", "in": "query", "description": "Unique Name of the workflow, to start workflow using unique_name of it\n(Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "UniqueName" }, "x-go-name": "UniqueName" }, { "name": "sync", "in": "query", "description": "if true, starts workflow with sync.\nIf workflow execution takes more than 28 second, API returns the current status of the instance\nand workflow continue to run in the background\nAPI returns 200 Ok on successful completion of instance\nAPI return 201 Accepted if the workflow still in running state after 28 second", "schema": { "type": "boolean", "x-go-name": "Sync" }, "x-go-name": "Sync" }, { "name": "async", "in": "query", "description": "if true, workflow execution is processed asynchronously", "schema": { "type": "boolean", "x-go-name": "Async" }, "x-go-name": "Async" } ], "requestBody": { "description": "The workflow to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startWorklfowPostRequestPayload" } } }, "required": false, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An RunWorkflowResponse response model\n\n# This is used for returning a response of workflow as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StartWorkflowResponse" } } } } }, "202": { "description": "An RunWorkflowResponse response model\n\n# This is used for returning a response of workflow as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StartWorkflowResponse" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/start_config": { "get": { "tags": [ "Workflows" ], "summary": "Handler to return required input parameters for the workflow.", "description": "Allowed Role(s): admin, user\nAllowed User(s): Who have RUN permission to given workflow", "operationId": "workflowInputParams", "parameters": [ { "name": "workflow_id", "in": "query", "description": "The ID of Workflow (Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "unique_name", "in": "query", "description": "The UniqueName of Workflow (Not allow to provide both of ID and UniqueName of Workflow)", "schema": { "type": "string", "x-go-name": "UniqueName" }, "x-go-name": "UniqueName" } ], "responses": { "200": { "description": "An StartWorklfowCfgResponse response model\n\n# This is used for returning a response of the workflow required parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartWorklfowConfigResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/summary": { "get": { "tags": [ "Workflows" ], "summary": "Handler to get a summary of workflows.", "description": "Including total number of workflows, total number of validated workflows and total number of draft workflows\nAllowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to workflow", "operationId": "worklowSummaryQueryParam", "responses": { "200": { "description": "An GetWorkflowSummaryResponse model.\n\n# It will return a summary of workflows", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowSummaryResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}": { "get": { "tags": [ "Workflows" ], "summary": "Handler to return workflow information using workflow ID.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getWorkflowById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "This represents the identifier of the workflow, which can be either a ksuid or a unique name.", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "A WorkflowDefinitonResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Workflows" ], "summary": "Handler to update the workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "workflowUpdateRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "The request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDefinitionPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A WorkflowUpdateResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDefinitionPutResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Workflows" ], "summary": "Handler to delete workflow using ID.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "deleteWorkflowById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "202": { "description": "A WorkflowDefinitonResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/actions": { "post": { "tags": [ "Workflows" ], "summary": "Handler to add new action to workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "addActionRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The definitionId of workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "The request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddActionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ActionDefinitonResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/{workflow_id}/actions/{action_id}": { "get": { "tags": [ "Workflows" ], "summary": "Handler to return Workflow's action information using action ID.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "getActionById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "path", "description": "The Id of an Action", "required": true, "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" } ], "responses": { "200": { "description": "An ActionDefinitonResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Workflows" ], "summary": "Handler to update an Action.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "actionUpdateRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "path", "description": "The Id of an Action", "required": true, "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" } ], "requestBody": { "description": "An action to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ActionPutResponse response model\n\n# This is used for returning a response of an action as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionPutResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Workflows" ], "summary": "Handler to delete an action from workflow byId.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "deleteActionById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "path", "description": "The Id of an Action", "required": true, "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" } ], "responses": { "200": { "description": "An ActionPutResponse response model\n\n# This is used for returning a response of an action as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionPutResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "patch": { "tags": [ "Workflows" ], "summary": "Handler to move actions in workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "modifyActionStepsRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "path", "description": "The Id of an Action", "required": true, "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" } ], "requestBody": { "description": "An request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionPatchRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An ActionPutResponse response model\n\n# This is used for returning a response of an action as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionPutResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/{workflow_id}/actions/{action_id}/duplicate": { "post": { "tags": [ "Workflows" ], "summary": "Handler to duplicate action.", "operationId": "duplicateActionById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "path", "description": "The Id of an Action", "required": true, "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" } ], "responses": { "200": { "description": "An ActionDefinitonResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/lock": { "put": { "tags": [ "Workflows" ], "summary": "Handler to Lock the workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "workflowLockPutRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "Message", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true, "x-go-name": "Message" }, "responses": { "200": { "description": "A WorkflowLockResponse model.", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "message" } }, "/v1/workflows/{workflow_id}/references": { "get": { "tags": [ "Workflows", "WorkflowVariableReferences" ], "summary": "Handler to return references for the workflow.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have VIEW permission to given workflow", "operationId": "workflowObjRefRequestQueryParams", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "action_id", "in": "query", "description": "The Id of Action", "schema": { "type": "string", "x-go-name": "ActionID" }, "x-go-name": "ActionID" }, { "name": "variable_id", "in": "query", "description": "The Id of Variable", "schema": { "type": "string", "x-go-name": "VariableID" }, "x-go-name": "VariableID" } ], "responses": { "200": { "description": "workflowObjRefResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowObjRefResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/rules": { "get": { "tags": [ "Workflows" ], "summary": "Handler to return rules for the workflow.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have VIEW permission to given workflow", "operationId": "getRulesByWorkflowID", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "WorkflowRulesResponse response model\n\n# This is used for returning rules of a workflow", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/WFRuleResponse" } } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/triggers": { "get": { "tags": [ "Triggers" ], "summary": "# Handler to get all triggers information", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have VIEW permission to given workflow", "operationId": "getTriggersById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "An TriggerGetAllResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Trigger" } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "post": { "tags": [ "Triggers" ], "summary": "# Handler to get create a trigger for a workflow", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "triggerCreateRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "The trigger to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "An TriggerGetResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v1/workflows/{workflow_id}/triggers/{trigger_id}": { "get": { "tags": [ "Triggers" ], "summary": "# Handler to get a trigger information by ID", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have VIEW permission to given workflow", "operationId": "getTriggerById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "trigger_id", "in": "path", "description": "The Id of Trigger", "required": true, "schema": { "type": "string", "x-go-name": "TriggerID" }, "x-go-name": "TriggerID" } ], "responses": { "200": { "description": "An TriggerGetResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } }, "put": { "tags": [ "Triggers" ], "summary": "# Handler to update trigger", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "triggerUpdateRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "trigger_id", "in": "path", "description": "The Id of Trigger", "required": true, "schema": { "type": "string", "x-go-name": "TriggerID" }, "x-go-name": "TriggerID" } ], "requestBody": { "description": "The trigger to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerPutRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "An TriggerGetResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" }, "delete": { "tags": [ "Triggers" ], "summary": "# Handler to delete trigger", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "triggerDeleteRequest", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "trigger_id", "in": "path", "description": "The Id of Trigger", "required": true, "schema": { "type": "string", "x-go-name": "TriggerID" }, "x-go-name": "TriggerID" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/unlock": { "put": { "tags": [ "Workflows" ], "summary": "Handler to unlock a locked workflow. Param {workflow_id} accepts both an id and unique_name of the workflow", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "unlockWorkflow", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "A WorkflowLockResponse model.", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/workflows/{workflow_id}/validate": { "post": { "tags": [ "Workflows" ], "summary": "Handler to validate workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "validateWorkflowParams", "parameters": [ { "name": "workflow_id", "in": "path", "description": "This represents the identifier of the workflow, which can be either a ksuid or a unique name.", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "responses": { "200": { "description": "An WorkflowValidationResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowValidationGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/xchange/{xchange_id}": { "get": { "tags": [ "Xchange" ], "summary": "Handler to return xchange object's information using xchange ID or unique name.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "readXchangeByIDParams", "parameters": [ { "name": "xchange_id", "in": "path", "description": "The xchangeID of xchange", "required": true, "schema": { "type": "string", "x-go-name": "XchangeID" }, "x-go-name": "XchangeID" } ], "responses": { "200": { "description": "An XchangeDefinitionResponse response model\n\n# This is used to return a response of Xchange workflow or Xchange pack as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XchangeGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/xchange/{xchange_id}/releasenotes": { "get": { "tags": [ "Xchange" ], "summary": "Handler to return xchange's release notes of all the published versions using xchange ID.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given workflow", "operationId": "readReleaseNotesParams", "parameters": [ { "name": "xchange_id", "in": "path", "description": "The xchangeID of xchange", "required": true, "schema": { "type": "string", "x-go-name": "XchangeID" }, "x-go-name": "XchangeID" } ], "responses": { "200": { "description": "An XchangeReleaseNotes response model\n\n# This is used to return a response of Xchange's release notes", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReleaseNote" } } } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/xchanges": { "post": { "tags": [ "Xchange" ], "summary": "Handler to return xchange objects.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given xchange_workflow or xchange_pack", "operationId": "readAllXchangeQueryParams", "parameters": [ { "name": "section", "in": "query", "description": "The section which the xchange document belongs to.", "schema": { "type": "string", "x-go-name": "Section" }, "x-go-name": "Section" }, { "name": "start", "in": "query", "description": "Start return list of instances from the number specified", "schema": { "type": "integer", "format": "uint8", "x-go-name": "Start" }, "x-go-name": "Start" }, { "name": "limit", "in": "query", "description": "Number of xchange instances will return by this request, must between 0-100", "schema": { "type": "integer", "format": "uint8", "x-go-name": "Limit" }, "x-go-name": "Limit" }, { "name": "state", "in": "query", "description": "Comma separated list of xchange states to filter", "schema": { "type": "string", "x-go-name": "State" }, "x-go-name": "State" } ], "responses": { "200": { "description": "An XchangeGetAllResponse response model\n\n# This is used for returning a collection of xchange in body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XchangeGetAllPaginationResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v1/xchanges/featured": { "post": { "tags": [ "Xchange" ], "summary": "Handler to replace the featured xchanges.", "description": "Allowed Role(s): admin, user, sat\nAllowed User(s): Who have atleast VIEW permission to given xchange_workflow or xchange_pack", "operationId": "XChangeFeaturedPostRequest", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XChangeIDOrder" } } } }, "required": true, "x-go-name": "XChangeInfo" }, "responses": { "200": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "xchange_info" } }, "/v1/{workflow_id}/uninstall": { "delete": { "tags": [ "Workflows" ], "summary": "Handler to unintsall a workflow installed through exchange.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MANAGE permission to given workflow", "operationId": "uninstallWorkflowById", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of Workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" }, { "name": "continue_uninstall", "in": "query", "description": "The parameter which indicates whether to continue uninstall", "schema": { "type": "string", "x-go-name": "ContinueUninstall" }, "x-go-name": "ContinueUninstall" } ], "responses": { "204": { "description": "NoContent response model", "content": {} }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "401": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "412": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v2/tenants": { "post": { "tags": [ "Tenants" ], "summary": "Handler to create a Tenant.", "description": "Allowed Role(s): admin, user", "operationId": "TenantPostRequest", "responses": { "201": { "description": "Tenant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "409": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } } } }, "/v2/workflows": { "post": { "tags": [ "Workflows" ], "summary": "Handler to create a workflow definition from a given template.", "description": "Allowed Role(s): admin\n\nType should be provided in request body to create a Workflow.", "operationId": "templateWorkflowCreateRequest", "requestBody": { "description": "The request to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/templateDefinitionPostRequest" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "201": { "description": "A WorkflowDefinitonResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } }, "/v2/workflows/{workflow_id}": { "put": { "tags": [ "Workflows" ], "summary": "Handler to update the workflow.", "description": "Allowed Role(s): admin\nAllowed User(s): Who have MODIFY/MANAGE permission to given workflow", "operationId": "workflowUpdateRequestV2", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The Id of workflow", "required": true, "schema": { "type": "string", "x-go-name": "WorkflowID" }, "x-go-name": "WorkflowID" } ], "requestBody": { "description": "The request body to submit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDefinitionPutRequestV2" } } }, "required": true, "x-go-name": "RequestBody" }, "responses": { "200": { "description": "A WorkflowUpdateResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDefinitionPutResponse" } } } }, "400": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "403": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "404": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "423": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "500": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} } }, "x-codegen-request-body-name": "request_body" } } }, "components": { "schemas": { "AccessMeta": { "title": "AccessMeta ...", "type": "object", "properties": { "adapter": { "$ref": "#/components/schemas/AccessMetaType" }, "deprecated": { "$ref": "#/components/schemas/Deprecated" }, "disable_duplicate": { "type": "boolean", "x-go-name": "DisableDuplicate" }, "is_integration": { "type": "boolean", "x-go-name": "IsIntegration" }, "is_internal": { "type": "boolean", "x-go-name": "IsInternal" }, "obsolete": { "$ref": "#/components/schemas/Obsolete" }, "runtime_users": { "type": "array", "items": { "$ref": "#/components/schemas/AccessMetaType" }, "x-go-name": "RuntimeUsers" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/AccessMetaType" }, "x-go-name": "Targets" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "AccessMetaType": { "title": "AccessMetaType ...", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID" }, "type": { "type": "string", "x-go-name": "Type" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ActionDefExport": { "title": "ActionDefExport ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefExport" }, "x-go-name": "Actions" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefExport" }, "x-go-name": "Branches" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ActionDefinitionGetAllPropsResponse": { "title": "ActionDefinitionGetAllPropsResponse ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefinitionGetAllPropsResponse" }, "x-go-name": "Actions" }, "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefinitionGetAllPropsResponse" }, "x-go-name": "Branches" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "name": { "type": "string", "x-go-name": "Name" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "skip_execution": { "type": "boolean", "x-go-name": "SkipExecution" }, "status": { "$ref": "#/components/schemas/Status" }, "subworkflow_valid": { "type": "boolean", "x-go-name": "SubWorkflowValid" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ActionDefinitionGetResponse": { "title": "ActionDefinitionGetResponse ...", "type": "object", "properties": { "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" }, "x-go-name": "Branches" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "name": { "type": "string", "x-go-name": "Name" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "skip_execution": { "type": "boolean", "x-go-name": "SkipExecution" }, "status": { "$ref": "#/components/schemas/Status" }, "subworkflow_valid": { "type": "boolean", "x-go-name": "SubWorkflowValid" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ActionDefinitionPatchRequest": { "title": "ActionDefinitionPatchRequest ...", "type": "object", "properties": { "block_num": { "type": "integer", "format": "int32", "x-go-name": "BlockNum" }, "id": { "type": "string", "x-go-name": "DefinitionID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ActionDefinitionPostRequest": { "title": "ActionDefinitionPostRequest ...", "type": "object", "properties": { "block_num": { "type": "integer", "format": "int32", "x-go-name": "BlockNum" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ActionDefinitionPutRequest": { "title": "ActionDefinitionPutRequest ...", "type": "object", "properties": { "description": { "type": "string", "description": "Description of an Action", "x-go-name": "Description" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "InvalidProperties of an Action", "x-go-name": "InvalidProperties" }, "name": { "type": "string", "description": "Name of an Action", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of an Action", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of an Action", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ActionDefinitionPutResponse": { "title": "ActionDefinitionPutResponse ...", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" }, "invalid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "InvalidActions" }, "valid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "ValidActions" }, "workflow_valid": { "type": "boolean", "x-go-name": "WorkflowValid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ActionFunc": { "title": "ActionFunc ...", "type": "object", "properties": { "is_microservice": { "type": "boolean", "x-go-name": "IsMicroservice" }, "micro_service": { "$ref": "#/components/schemas/MicroService" }, "serverless": { "$ref": "#/components/schemas/Serverless" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ActionInstanceGetAllResponse": { "title": "ActionInstanceGetAllResponse ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInstanceGetAllResponse" }, "x-go-name": "Actions" }, "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInstanceGetAllResponse" }, "x-go-name": "Branches" }, "blocks_count": { "type": "integer", "format": "int64", "x-go-name": "BranchesCount" }, "definition_id": { "type": "string", "x-go-name": "DefinitionID" }, "id": { "type": "string", "x-go-name": "InstanceID" }, "name": { "type": "string", "x-go-name": "Name" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "skip_execution": { "type": "boolean", "x-go-name": "SkipExecution" }, "status": { "$ref": "#/components/schemas/Status" }, "subworkflow_id": { "type": "string", "x-go-name": "SubWorkflowID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "version": { "type": "string", "x-go-name": "Version" }, "workflow_id": { "type": "string", "x-go-name": "WorkflowID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ActionInstanceGetResponse": { "title": "ActionInstanceGetResponse ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInstanceGetAllResponse" }, "x-go-name": "Actions" }, "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInstanceGetAllResponse" }, "x-go-name": "Branches" }, "definition_id": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "x-go-name": "Description" }, "ended_on": { "type": "string", "format": "date-time", "x-go-name": "EndedOn" }, "id": { "type": "string", "x-go-name": "InstanceID" }, "name": { "type": "string", "x-go-name": "Name" }, "output": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Output" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "skip_execution": { "type": "boolean", "x-go-name": "SkipExecution" }, "started_by": { "type": "string", "x-go-name": "StartedBy" }, "started_on": { "type": "string", "format": "date-time", "x-go-name": "StartedOn" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "ui_config": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "UIConfig" }, "version": { "type": "string", "x-go-name": "Version" }, "workflow_id": { "type": "string", "x-go-name": "WorkflowID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ActionOutputVariable": { "title": "ActionOutputVariable ..", "type": "object", "properties": { "item_type": { "type": "string", "x-go-name": "ItemType" }, "output_variable": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OutputInfo" }, "x-go-name": "Output" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ActionPatchRequest": { "title": "ActionPatchRequest ...", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/ActionDefinitionPatchRequest" }, "previous_action": { "$ref": "#/components/schemas/ActionDefinitionPatchRequest" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ActionTableInfo": { "title": "ActionTableInfo ..", "type": "object", "properties": { "table_id": { "type": "string", "x-go-name": "TableID" }, "table_obj_type": { "$ref": "#/components/schemas/LHObjType" }, "table_type_id": { "type": "string", "x-go-name": "TableTypeID" }, "table_type_obj_type": { "$ref": "#/components/schemas/LHObjType" }, "variable_id": { "type": "string", "x-go-name": "VariableID" }, "variable_scope": { "type": "string", "x-go-name": "VariableScope" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "AddActionPostRequest": { "title": "AddActionPostRequest ...", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/ActionDefinitionPostRequest" }, "previous_action": { "$ref": "#/components/schemas/ActionDefinitionPatchRequest" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "AllReferences": { "type": "object", "properties": { "used_by": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "x-go-name": "UsedBy" }, "uses": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "x-go-name": "Uses" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "AssigneeResponse": { "title": "AssigneeResponse ...", "type": "object", "properties": { "assignee": { "type": "string", "x-go-name": "Assignee" }, "message": { "type": "string", "x-go-name": "Message" }, "response": { "type": "string", "x-go-name": "Response" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Calendar": { "title": "Calendar ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "calendar_type": { "type": "string", "x-go-name": "CalendarType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "CalendarID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "properties": {}, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/base-microservice/longhorn-cron" }, "CalendarExport": { "title": "CalendarExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "calendar_type": { "type": "string", "x-go-name": "CalendarType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CalendarGetAllResponse": { "title": "CalendarGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "calendar_type": { "type": "string", "x-go-name": "CalendarType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "CalendarID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "CalendarGetResponse": { "title": "CalendarGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "calendar_type": { "type": "string", "x-go-name": "CalendarType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "CalendarID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "properties": {}, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "CalendarPostRequest": { "title": "CalendarPostRequest ..", "required": [ "name", "properties" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Calendar", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Calendar", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of Calendar", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Calendar", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of Calendar", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Properties of Calendar", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Calendar.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CalendarPutRequest": { "title": "CalendarPutRequest ...", "required": [ "properties" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Calendar", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Calendar", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of Calendar", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of Calendar", "x-go-name": "Title" }, "unique_name": { "type": "string", "description": "Properties of Category", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CategoryExport": { "title": "CategoryExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "category_type": { "$ref": "#/components/schemas/CategoryType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CategoryGetResponse": { "title": "CategoryGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "category_type": { "$ref": "#/components/schemas/CategoryType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "CategoryID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "CategoryPostRequest": { "title": "CategoryPostRequest ...", "required": [ "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Category", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Category", "x-go-name": "Name" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Category", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of Category", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Properties of Category", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Category.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CategoryPutRequest": { "title": "CategoryPutRequest represents a payload for modifying an existing category by its ID.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Category", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Category", "x-go-name": "Name" }, "title": { "type": "string", "description": "Title of Category", "x-go-name": "Title" }, "unique_name": { "type": "string", "description": "Properties of Category", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CategoryType": { "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ChangeOwnerRequest": { "title": "ChangeOwnerRequest ...", "required": [ "base_type", "owner" ], "type": "object", "properties": { "base_type": { "type": "string", "description": "BaseType of entity", "x-go-name": "BaseType" }, "owner": { "type": "string", "description": "Owner ID of the entity", "x-go-name": "Owner" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ColumnData": { "title": "ColumnData ..", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ColumnMapInfo": { "title": "ColumnMapInfo will be one entry in column map", "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnData" }, "x-go-name": "Columns" }, "parent_action_ids": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "ParentMap" }, "persist_output_as_table": { "type": "boolean", "x-go-name": "PersistOutput" }, "table_type_columns": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnData" } }, "x-go-name": "TblTypeColumns" }, "table_type_id": { "type": "string", "x-go-name": "TableTypeID" } }, "description": "{\n\"table_type_id\": \"16bsMd7aS2mqII9n5bIe8EGIl39\",\n\"table_type_columns\": {\n\"\": [\n{\n\"name\": \"id\",\n\"type\": \"number\"\n},\n{\n\"name\": \"name\",\n\"type\": \"string\"\n}\n]\n},\n\"parent_action_ids\": {\n\"\" : \"\"\n},\n\"columns\": [\n{\n\"name\": \"id\",\n\"type\": \"number\"\n},\n{\n\"name\": \"name\",\n\"type\": \"string\"\n}\n]\n}", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "CommentPostRequest": { "title": "CommentPostRequest", "required": [ "message", "ref_base_type", "ref_id", "ref_type" ], "type": "object", "properties": { "message": { "type": "string", "description": "The message.", "x-go-name": "Message" }, "ref_base_type": { "type": "string", "description": "The base type of the entity.", "x-go-name": "RefBaseType" }, "ref_id": { "type": "string", "description": "The ID of the entity.", "x-go-name": "RefID" }, "ref_type": { "type": "string", "description": "The type of the entity.", "x-go-name": "RefType" } }, "description": "The comment create request model.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "CommentsPostRequestParams": { "title": "CommentsPostRequestParams ...", "required": [ "ref_id", "ref_object_type" ], "type": "object", "properties": { "ref_id": { "type": "string", "description": "commented object ID to get for.\nin: body", "x-go-name": "RefID" }, "ref_object_type": { "$ref": "#/components/schemas/LHObjType" }, "version": { "type": "string", "description": "commented version to get for.\nin: body", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "CourseOfAction": { "title": "WorkflowMetaData ...", "required": [ "observable_types" ], "type": "object", "properties": { "actuator": { "type": "string", "description": "Actuator.\nin: body", "x-go-name": "Actuator" }, "observable_types": { "type": "array", "description": "list of observable types to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "ObservableTypes" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "CreateTableTypeGetResponse": { "title": "CreateTableTypeGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_type": { "type": "string", "x-go-name": "DataType" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "has_tables": { "type": "boolean", "x-go-name": "HasTables" }, "id": { "type": "string", "x-go-name": "TableTypeID" }, "inherits": { "type": "string", "x-go-name": "Inherits" }, "max_column_size": { "type": "integer", "format": "int64", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "format": "int64", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "format": "int64", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "format": "int64", "x-go-name": "MaxTableSize" }, "owner": { "type": "string", "x-go-name": "Owner" }, "row_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "RowSchema" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "DefAccessMeta": { "title": "DefAccessMeta ...", "type": "object", "properties": { "is_integration": { "type": "boolean", "x-go-name": "IsIntegration" }, "is_internal": { "type": "boolean", "x-go-name": "IsInternal" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "DefinitionExport": { "title": "DefinitionExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Deprecated": { "title": "Deprecated ...", "type": "object", "properties": { "deprecated_in": { "type": "string", "x-go-name": "DeprecatedIn" }, "deprecated_message": { "type": "string", "x-go-name": "DeprecatedMessage" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "DueTaskDateInfo": { "title": "DueTaskDateInfo ...", "type": "object", "properties": { "is_relative_time": { "type": "boolean", "x-go-name": "IsRelativeTime" }, "is_specified_date": { "type": "boolean", "x-go-name": "IsSpecifiedDate" }, "relative_time": { "$ref": "#/components/schemas/RelativeTime" }, "set_due_date": { "type": "boolean", "x-go-name": "SetDueDate" }, "specified_date": { "type": "string", "x-go-name": "SpecifiedDate" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "DynamicMap": { "title": "DynamicMap will have two individual map\nActionVariableMap will look like following:\n\"action_variable_map\": {\n\"\": {\n\"jsonpath_queries_1\": {\n\"type\": \"array\",\n\"output_variable\":{\n\"script_query_name\":{\n\"name\": \"script_query_name\",\n\"type\":\"string\"\n},\n\"script_query_name_1\":{\n\"name\": \"script_query_name_1\",\n\"type\":\"string\"\n}\n}\n}\n\"jsonpath_queries_2\": {\n\"type\": \"object\",\n\"output_variable\":{\n\"query_name\":{\n\"name\": \"query_name\",\n\"type\":\"string\"\n}\n}\n}\n}\n}\nAction output table is for orchestrator to keep track of dynamic created table and table type\nit will look like following:\n\"action_output_table\": {\n\"\": {\n\"\": {\n\"table_id\": \"\",\n\"table_type_id\": \"\"\n},\n\"\": {\n\"table_id\": \"\",\n\"table_type_id\": \"\"\n}\n}\n}", "type": "object", "properties": { "action_output_table": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionTableInfo" } }, "description": "Action output table will be used for workflow instance\nDo not initialize for workflow definition", "x-go-name": "ActionOutputTable" }, "action_variable_map": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActionOutputVariable" } }, "x-go-name": "ActionVariableMap" }, "column_map": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ColumnMapInfo" }, "x-go-name": "ColumnMap" } }, "description": "DynamicMap ..", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "EntitlementSummary": { "type": "object", "properties": { "techvals": { "$ref": "#/components/schemas/TechVals" }, "tier": { "$ref": "#/components/schemas/Tier" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Event": { "title": "Event ...", "required": [ "properties" ], "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "EventID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of event", "x-go-name": "Properties" }, "rule_id": { "type": "string", "x-go-name": "RuleID" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "EventExport": { "title": "EventExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "rule_id": { "type": "string", "x-go-name": "RuleID" }, "target_id": { "type": "string", "x-go-name": "TargetID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" }, "webhook_id": { "type": "string", "x-go-name": "WebhookID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "EventPostRequest": { "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Event", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Event", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of event", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Schedule", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of Event", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "EventPostRequest struct for events post api\nEither ViewSchemaID or Type or both can be provided to create an Event.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "EventPutRequest": { "title": "EventPutRequest ...", "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Event", "x-go-name": "Description" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of event", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of Event", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Expression": { "title": "Expression ....", "type": "object", "properties": { "left_operand": { "type": "object", "properties": {}, "x-go-name": "LeftOperand" }, "operator": { "type": "string", "x-go-name": "Operator" }, "right_operand": { "type": "object", "properties": {}, "x-go-name": "RightOperand" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/base-microservice/longhornparser/models" }, "ExternalLinks": { "type": "object", "properties": { "key": { "type": "string", "x-go-name": "Title" }, "value": { "type": "string", "x-go-name": "URL" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "FormElement": { "title": "FormElement ...", "type": "object", "properties": { "allow_multiselect": { "type": "boolean", "x-go-name": "AllowMultiselect" }, "form_element": { "$ref": "#/components/schemas/FormElementType" }, "form_label": { "type": "string", "x-go-name": "Label" }, "form_label_text": { "type": "string", "x-go-name": "Text" }, "form_source_array": { "type": "object", "properties": {}, "x-go-name": "DropDown" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "FormElementType": { "type": "string", "description": "FormElementType contains the FromElement type enum", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "GetAllCalendarPaginatedResponse": { "title": "An GetAllCalendarPaginatedResponse model.", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarGetAllResponse" }, "x-go-name": "Results" }, "total_count": { "type": "integer", "format": "int32", "x-go-name": "TotalCount" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllCommentsResponse": { "title": "An GetAllCommentsResponse model.", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/comment" }, "x-go-name": "Results" }, "total_count": { "type": "integer", "format": "int32", "x-go-name": "TotalCount" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllRuleResponse": { "title": "An GetAllRuleResponse model.", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "group_by_priority_order": { "type": "string", "x-go-name": "GroupByPriorityOrder" }, "id": { "type": "string", "x-go-name": "RuleID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "rule_type": { "$ref": "#/components/schemas/RuleType" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "standalone": { "type": "string", "x-go-name": "Standalone" }, "status": { "$ref": "#/components/schemas/RuleStatus" }, "stop_subsequent_rules": { "type": "string", "x-go-name": "StopSubsequentRules" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllRulesPaginatedResponse": { "title": "An GetAllRulesPaginatedResponse model.", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/GetAllRuleResponse" }, "x-go-name": "Results" }, "total_count": { "type": "integer", "format": "int32", "x-go-name": "TotalCount" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllTaskResponse": { "title": "An GetAllTaskResponse model.", "type": "object", "properties": { "action_instance_id": { "type": "string", "x-go-name": "ActionInstanceID" }, "approval_choices": { "type": "array", "items": { "type": "string" }, "x-go-name": "ApprovalChoices" }, "assignee_responses": { "type": "array", "items": { "$ref": "#/components/schemas/AssigneeResponse" }, "x-go-name": "AssigneeResponses" }, "assignee_roles": { "type": "array", "items": { "type": "string" }, "x-go-name": "AssigneeRoles" }, "assignees": { "type": "array", "items": { "type": "string" }, "x-go-name": "Assignees" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "due_date": { "$ref": "#/components/schemas/LHTime" }, "expiration_date": { "$ref": "#/components/schemas/LHTime" }, "expiration_status": { "type": "string", "x-go-name": "ExpirationStatus" }, "id": { "type": "string", "x-go-name": "TaskID" }, "minimum_approvals": { "type": "integer", "format": "uint32", "x-go-name": "MinimumApprovals" }, "priority": { "$ref": "#/components/schemas/TaskPriority" }, "prompt_title": { "type": "string", "x-go-name": "PromptTitle" }, "response": { "type": "string", "x-go-name": "Response" }, "status": { "$ref": "#/components/schemas/Status" }, "subject_line": { "type": "string", "x-go-name": "SubjectLine" }, "task_owner": { "type": "string", "x-go-name": "TaskOwner" }, "task_requestor": { "type": "string", "x-go-name": "TaskRequestor" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "wf_instance_id": { "type": "string", "x-go-name": "WFInstanceID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllTasksResponse": { "title": "An GetAllTasksResponse model.", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/GetAllTaskResponse" }, "x-go-name": "Results" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllVarTypesPostRequest": { "title": "GetAllVarTypesPostRequest ...", "type": "object", "properties": { "type": { "type": "string", "description": "type of variabletypes, values datatype.object/datatype.array\nin: body", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetAllVariableTypesResponse": { "title": "A GetAllVariableTypesResponse model.", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "type": "object", "properties": {} }, "x-go-name": "Results" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GetTaskResponse": { "title": "An GetTaskResponse model.", "type": "object", "properties": { "action_instance_id": { "type": "string", "x-go-name": "ActionInstanceID" }, "approval_choices": { "type": "array", "items": { "type": "string" }, "x-go-name": "ApprovalChoices" }, "assignee_responses": { "type": "array", "items": { "$ref": "#/components/schemas/AssigneeResponse" }, "x-go-name": "AssigneeResponses" }, "assignee_roles": { "type": "array", "items": { "type": "string" }, "x-go-name": "AssigneeRoles" }, "assignees": { "type": "array", "items": { "type": "string" }, "x-go-name": "Assignees" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "due_date": { "$ref": "#/components/schemas/LHTime" }, "expiration_date": { "$ref": "#/components/schemas/LHTime" }, "expiration_status": { "type": "string", "x-go-name": "ExpirationStatus" }, "form_elements": { "type": "array", "items": { "$ref": "#/components/schemas/FormElement" }, "x-go-name": "FormElements" }, "id": { "type": "string", "x-go-name": "TaskID" }, "minimum_approvals": { "type": "integer", "format": "uint32", "x-go-name": "MinimumApprovals" }, "priority": { "$ref": "#/components/schemas/TaskPriority" }, "prompt_body_text": { "type": "string", "x-go-name": "PromptBodyText" }, "prompt_response": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PromptResponse" }, "response": { "type": "string", "x-go-name": "Response" }, "status": { "$ref": "#/components/schemas/Status" }, "subject_line": { "type": "string", "x-go-name": "SubjectLine" }, "task_message": { "type": "string", "x-go-name": "ApprovalMessage" }, "task_owner": { "type": "string", "x-go-name": "TaskOwner" }, "task_requestor": { "type": "string", "x-go-name": "TaskRequestor" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "wf_instance_id": { "type": "string", "x-go-name": "WFInstanceID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "GitInfo": { "type": "object", "properties": { "commit_hash": { "type": "string", "x-go-name": "CommitHash" }, "commit_message": { "type": "string", "x-go-name": "CommitMessage" }, "commited_by": { "type": "string", "x-go-name": "CommitedBy" }, "commited_on": { "type": "string", "format": "date-time", "x-go-name": "CommitedOn" }, "file_name": { "type": "string", "x-go-name": "FileName" }, "target_id": { "type": "string", "x-go-name": "TargetID" } }, "description": "nolint: misspell\nGitInfo maintains information about the last Git Import", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "GroupPermission": { "title": "GroupPermission ...", "required": [ "id", "permissions" ], "type": "object", "properties": { "id": { "type": "string", "description": "An ID of group", "x-go-name": "ID" }, "permissions": { "type": "array", "description": "Permissions of the entity, Type of permissions can be: \"view\", \"run\", \"modify\", \"manage\"", "items": { "type": "string" }, "x-go-name": "Permissions" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "IXChange": { "title": "IXChange ...", "type": "object", "properties": { "GetAuthoredBy": { "type": "string", "description": "GetAuthoredBy ..." }, "GetBaseType": { "type": "string", "description": "GetBaseType ..." }, "GetBlurb": { "type": "string", "description": "GetBlurb ..." }, "GetCategories": { "type": "array", "description": "GetCategories ...", "items": { "type": "string" } }, "GetContactEmail": { "type": "string", "description": "GetContactEmail ..." }, "GetCreatedBy": { "type": "string", "description": "GetCreatedBy ..." }, "GetCreatedOn": { "type": "string", "description": "GetCreatedOn ...", "format": "date-time" }, "GetDataSchemaID": { "type": "string", "description": "GetDataSchemaID ..." }, "GetDocumentID": { "type": "string", "description": "GetDocumentID returns xchange id" }, "GetExternalLinks": { "type": "array", "description": "GetExternalLinks ...", "items": { "$ref": "#/components/schemas/ExternalLinks" } }, "GetImage": { "type": "string", "description": "GetImage ..." }, "GetInstallInfo": { "$ref": "#/components/schemas/InstallInfo" }, "GetInstalledCount": { "type": "integer", "description": "GetInstalledCount ...", "format": "uint32" }, "GetLatestVersion": { "type": "string", "description": "GetLatestVersion ..." }, "GetName": { "type": "string", "description": "GetName ..." }, "GetObjectType": { "$ref": "#/components/schemas/LHObjType" }, "GetOwner": { "type": "string", "description": "GetOwner ..." }, "GetPath": { "type": "string", "description": "GetPath ..." }, "GetProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "GetProperties ..." }, "GetPublishedVersions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "GetPublishedVersions ..." }, "GetPublisherInfo": { "$ref": "#/components/schemas/PublisherInfo" }, "GetRating": { "$ref": "#/components/schemas/RatingInfo" }, "GetReleaseNote": { "type": "string", "description": "GetReleaseNote gets the release note" }, "GetRev": { "type": "integer", "description": "GetRev ...", "format": "int64" }, "GetState": { "$ref": "#/components/schemas/State" }, "GetStatus": { "$ref": "#/components/schemas/Status" }, "GetSubmitInfo": { "$ref": "#/components/schemas/SubmitInfo" }, "GetTenantID": { "type": "string", "description": "GetTenantID ..." }, "GetTitle": { "type": "string", "description": "GetTitle ..." }, "GetType": { "type": "string", "description": "GetType ..." }, "GetTypeOfSubmission": { "type": "string", "description": "GetTypeOfSubmission ..." }, "GetUniqueName": { "type": "string", "description": "GetUniqueName ..." }, "GetUpdatedBy": { "type": "string", "description": "GetUpdatedBy ..." }, "GetUpdatedOn": { "type": "string", "description": "GetUpdatedOn ...", "format": "date-time" }, "GetViewSchemaID": { "type": "string", "description": "GetViewSchemaID ..." }, "GetXChangeID": { "type": "string", "description": "GetXChangeID ..." }, "ObjType": { "type": "string", "description": "ObjType ..." } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "InstallInfo": { "title": "InstallInfo ...", "type": "object", "properties": { "installed_time": { "type": "string", "format": "date-time", "x-go-name": "InstalledTime" }, "status": { "$ref": "#/components/schemas/Status" }, "version": { "type": "string", "x-go-name": "InstalledVersion" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "LHObjType": { "title": "LHObjType generated on 2024-06-14T11:01:04+05:30. DO NOT EDIT.", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/mdb-maps/entity" }, "LHTime": { "type": "object", "description": "LHTime embeds time.Time", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Lock": { "type": "object", "properties": { "locked": { "type": "boolean", "x-go-name": "Locked" }, "locked_by": { "type": "string", "x-go-name": "LockedBy" }, "message": { "type": "string", "x-go-name": "Message" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "MetaDataHdr": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "meta_data_id": { "type": "string", "x-go-name": "MetaDataID" }, "meta_data_key": { "type": "string", "x-go-name": "MetaDataKey" }, "meta_data_name": { "type": "string", "x-go-name": "MetaDataName" }, "object_type": { "type": "string", "x-go-name": "ObjectType" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "description": "MetaDataHdr common Meta Data Object fields", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "MetadataRefreshToken": { "type": "object", "properties": { "_id": { "type": "string", "x-go-name": "MetaDataID" }, "_rev": { "type": "integer", "format": "int64", "x-go-name": "Rev" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "key_name": { "type": "string", "x-go-name": "KeyName" }, "meta_data_header": { "$ref": "#/components/schemas/MetaDataHdr" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "description": "model used for to return response", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "MicroService": { "title": "MicroService ...", "type": "object", "properties": { "end_point": { "type": "string", "x-go-name": "EndPoint" }, "name": { "type": "string", "x-go-name": "Name" }, "port": { "type": "integer", "format": "uint32", "x-go-name": "Port" }, "protocol": { "type": "string", "x-go-name": "Protocol" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ModuleInfo": { "type": "object", "properties": { "api_name": { "type": "string", "x-go-name": "APIName" }, "bypass_iroh_proxy": { "type": "boolean", "x-go-name": "ByPassIROHProxy" }, "external_id": { "type": "string", "x-go-name": "ExternalID" }, "flags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Flags" }, "id": { "type": "string", "x-go-name": "ModuleUniqueID" }, "integrated_module": { "type": "boolean", "x-go-name": "IntegratedModule" }, "module_instance_id": { "type": "string", "x-go-name": "ModuleInstanceID" }, "module_type": { "type": "string", "x-go-name": "ModuleType" }, "module_type_id": { "type": "string", "x-go-name": "ModuleTypeID" }, "openapi_spec": { "type": "string", "x-go-name": "APISpec" }, "revision": { "type": "string", "x-go-name": "Revision" }, "target_url": { "type": "string", "x-go-name": "TargetURL" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ObjectReference": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "x-go-name": "Date" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "ID" }, "name": { "type": "string", "x-go-name": "Name" }, "status": { "$ref": "#/components/schemas/Status" }, "type": { "type": "string", "x-go-name": "Type" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Obsolete": { "title": "Obsolete ...", "type": "object", "properties": { "obsolete_from": { "type": "string", "x-go-name": "ObsoleteFrom" }, "obsolete_message": { "type": "string", "x-go-name": "ObsoleteMessage" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "OutputInfo": { "title": "OutputInfo ..", "type": "object", "properties": { "items": { "$ref": "#/components/schemas/ActionOutputVariable" }, "name": { "type": "string", "x-go-name": "Name" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "PaginationLink": { "type": "object", "properties": { "next": { "type": "string", "x-go-name": "Next" }, "prev": { "type": "string", "x-go-name": "Prev" }, "self": { "type": "string", "x-go-name": "Self" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "PrevRulePriorityPatchRequest": { "title": "PrevRulePriorityPatchRequest ...", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "RuleID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "PublisherInfo": { "type": "object", "properties": { "published_by": { "type": "string", "x-go-name": "PublishedBy" }, "published_version": { "type": "string", "x-go-name": "PublishedVersion" }, "publisher_tenant_id": { "type": "string", "x-go-name": "PublisherTenantID" }, "status": { "$ref": "#/components/schemas/Status" } }, "description": "PublisherInfo applicable for only global xchange tenant", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "RatingInfo": { "type": "object", "properties": { "avg_rating": { "type": "number", "format": "double", "x-go-name": "AverageRating" }, "rating_updated_on": { "type": "string", "format": "date-time", "x-go-name": "RatingUpdatedOn" }, "total_no_of_ratings": { "type": "integer", "format": "uint32", "x-go-name": "TotalNoOfRatings" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "RatingLoginUserRequest": { "title": "RatingLoginUserRequest ...", "required": [ "ref_id", "ref_type" ], "type": "object", "properties": { "ref_id": { "type": "string", "description": "ref id", "x-go-name": "RefID" }, "ref_type": { "type": "string", "description": "ref type", "x-go-name": "RefType" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RatingPostRequest": { "title": "RatingPostRequest", "required": [ "rating", "ref_base_type", "ref_id", "ref_type" ], "type": "object", "properties": { "rating": { "type": "integer", "description": "The Rating.", "format": "uint8", "x-go-name": "Rating" }, "ref_base_type": { "type": "string", "description": "The base type of the entity.", "x-go-name": "RefBaseType" }, "ref_id": { "type": "string", "description": "The ID of the entity.", "x-go-name": "RefID" }, "ref_type": { "type": "string", "description": "The type of the entity.", "x-go-name": "RefType" } }, "description": "The rating create request model.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RatingPutRequest": { "title": "RatingPutRequest", "type": "object", "properties": { "rating": { "type": "integer", "format": "uint8", "x-go-name": "Rating" } }, "description": "The rating update request model.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RatingResponse": { "title": "A RatingResponse model.", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "RatingID" }, "rating": { "type": "integer", "format": "uint8", "x-go-name": "Rating" }, "ref_base_type": { "type": "string", "x-go-name": "RefBaseType" }, "ref_id": { "type": "string", "x-go-name": "RefID" }, "ref_object_type": { "$ref": "#/components/schemas/LHObjType" }, "type": { "type": "string", "x-go-name": "Type" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "RelativeTime": { "title": "RelativeTime ...", "type": "object", "properties": { "duration": { "type": "integer", "format": "int64", "x-go-name": "Duration" }, "time_units": { "$ref": "#/components/schemas/TimeUnit" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ReleaseNote": { "type": "object", "properties": { "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "rlease_note": { "type": "string", "x-go-name": "RleaseNote" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "RemoteMetaExport": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RemoteMetaGetAllResponse": { "title": "RemoteMetaGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_schema_id": { "type": "string", "x-go-name": "DataSchemaID" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "RemoteMetaID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" }, "view_schema_id": { "type": "string", "x-go-name": "ViewSchemaID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RemoteMetaGetResponse": { "title": "RemoteMetaGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "RemoteMetaID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RemoteMetaPostRequest": { "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of RemoteMeta", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of RemoteMeta", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of RemoteMeta", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of RemoteMeta", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of RemoteMeta", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "RemoteMetaPostRequest struct for remotemeta post api\nEither ViewSchemaID or Type or both can be provided to create an RemoteMeta.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "RemoteMetaPutRequest": { "title": "RemoteMetaPutRequest ...", "required": [ "properties", "title" ], "type": "object", "properties": { "RemoteMetaID": { "type": "string" }, "description": { "type": "string", "description": "Description of RemoteMeta", "x-go-name": "Description" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of RemoteMeta", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of RemoteMeta", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ResponseSummary": { "title": "ResponseSummary ...", "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "x-go-name": "Count" }, "created": { "type": "integer", "format": "uint32", "x-go-name": "Created" }, "deleted": { "type": "integer", "format": "uint32", "x-go-name": "Deleted" }, "has_object": { "type": "boolean", "x-go-name": "HasObject" }, "ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "IDs" }, "retrieved": { "type": "integer", "format": "uint32", "x-go-name": "Retrieved" }, "runningCount": { "type": "integer", "format": "int64", "x-go-name": "RunningCount" }, "updated": { "type": "integer", "format": "uint32", "x-go-name": "Updated" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Rule": { "title": "Rule ...", "required": [ "properties" ], "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "id": { "type": "string", "x-go-name": "RuleID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of rule", "x-go-name": "Properties" }, "rule_type": { "$ref": "#/components/schemas/RuleType" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/RuleStatus" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RuleExport": { "title": "RuleExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "rule_type": { "$ref": "#/components/schemas/RuleType" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RulePatchRequest": { "type": "object", "properties": { "previous_rule": { "$ref": "#/components/schemas/PrevRulePriorityPatchRequest" }, "rule": { "$ref": "#/components/schemas/RulePriorityPatchRequest" }, "type": { "type": "string", "x-go-name": "Type" } }, "description": "RulePatchRequest struct for rule patch api", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RulePostRequest": { "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Rule", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Rule", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of Rule", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Schedule", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of Rule", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "RulePostRequest struct for rule post api\nEither ViewSchemaID or Type or both can be provided to create an Rule.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RulePriorityPatchRequest": { "title": "RulePriorityPatchRequest ...", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "RuleID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RulePutRequest": { "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Rule", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Rule", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of Rule", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of Rule", "x-go-name": "Title" } }, "description": "RulePutRequest struct for rule put api", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RuleStatus": { "title": "RuleStatus ...", "type": "object", "properties": { "details": { "$ref": "#/components/schemas/StatusDetails" }, "error_msg": { "type": "string", "x-go-name": "ErrorMsg" }, "prev_state": { "$ref": "#/components/schemas/State" }, "state": { "$ref": "#/components/schemas/State" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "RuleType": { "title": "RuleType ...", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "RulesPostRequest": { "title": "RulesPostRequest ...", "type": "object", "properties": { "group_by_priority_order": { "type": "string", "description": "Flag for Group by, values: \"true\"/\"false\". Only supports incident rule types\nin: body", "x-go-name": "GroupByPriorityOrder" }, "standalone": { "type": "string", "description": "Flag for standalone rules, values: \"true\"/\"false\"\nin: body", "x-go-name": "Standalone" }, "types": { "type": "array", "description": "list of types to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "Types" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "RuntimeUserDefinitionGetAllResponse": { "title": "RuntimeUserDefinitionGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "def_access_meta": { "$ref": "#/components/schemas/DefAccessMeta" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "RuntimeUserDefinitionGetResponse": { "title": "RuntimeUserDefinitionGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "def_access_meta": { "$ref": "#/components/schemas/DefAccessMeta" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "RuntimeUserDefinitionPatchRequest": { "title": "RuntimeUserDefinitionPatchRequest ...", "type": "object", "properties": { "description": { "type": "string", "description": "Description of runtime user", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of runtime user", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of runtime user", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of runtime user", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "RuntimeUserDefinitionPostRequest": { "title": "RuntimeUserDefinitionPostRequest ...", "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Runtime User.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SXEventType": { "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "SXIROHEventEmiter": { "title": "SXIROHEventEmiter represents the emiter of an SX module event.", "type": "object", "properties": { "client_id": { "type": "string", "x-go-name": "ClientID" }, "org_id": { "type": "string", "x-go-name": "OrgID" }, "user_id": { "type": "string", "x-go-name": "UserID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SXIROHIncidentData": { "type": "object", "properties": { "event_type": { "$ref": "#/components/schemas/SXEventType" }, "incident_id": { "type": "string", "x-go-name": "IncidentID" }, "incident_status": { "type": "string", "x-go-name": "IncidentStatus" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SXIROHIncidentPostRequest": { "title": "SXIROHIncidentPostRequest represents the payload of a SX IROH incident.", "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "x-go-name": "CreatedAt" }, "data": { "$ref": "#/components/schemas/SXIROHIncidentData" }, "emiter": { "$ref": "#/components/schemas/SXIROHEventEmiter" }, "id": { "type": "string", "x-go-name": "ID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ScheduleDefinitionPostRequest": { "title": "SchedulePostRequest ...", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of Schedule", "x-go-name": "Name" }, "properties": { "$ref": "#/components/schemas/ScheduleProperties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Schedule", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Schedule.", "x-go-name": "SchedulePostRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ScheduleExport": { "title": "ScheduleExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "$ref": "#/components/schemas/ScheduleProperties" }, "rule_id": { "type": "string", "x-go-name": "RuleID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "ScheduleGetAllResponse": { "title": "ScheduleGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "ScheduleID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "rule_id": { "type": "string", "x-go-name": "RuleID" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ScheduleGetResponse": { "title": "ScheduleGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "ScheduleID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "$ref": "#/components/schemas/ScheduleProperties" }, "rule_id": { "type": "string", "x-go-name": "RuleID" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "ScheduleProperties": { "type": "object", "properties": { "calendar": { "type": "string", "x-go-name": "CalendarID" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "interval_hours": { "type": "integer", "format": "uint32", "x-go-name": "IntervalHours" }, "interval_minutes": { "type": "integer", "format": "uint32", "x-go-name": "IntervalMinutes" }, "number_of_times": { "type": "integer", "format": "uint32", "x-go-name": "NumberOfTimes" }, "starttime": { "type": "string", "x-go-name": "Starttime" }, "timezone": { "type": "string", "x-go-name": "Timezone" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SchedulePutRequest": { "title": "SchedulePutRequest ...", "type": "object", "properties": { "name": { "type": "string", "description": "Name of Schedule", "x-go-name": "Name" }, "properties": { "$ref": "#/components/schemas/ScheduleProperties" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Schema": { "title": "Schema ...", "type": "object", "properties": { "access_meta": { "$ref": "#/components/schemas/AccessMeta" }, "action_func": { "$ref": "#/components/schemas/ActionFunc" }, "attributes": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Attributes" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "group": { "type": "string", "x-go-name": "Group" }, "inherits": { "type": "object", "properties": {}, "x-go-name": "Inherits" }, "invisible": { "type": "boolean", "x-go-name": "Invisible" }, "name": { "type": "string", "x-go-name": "Name" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "owner": { "type": "string", "x-go-name": "Owner" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "schema_id": { "type": "string", "x-go-name": "SchemaID" }, "schema_type": { "type": "string", "x-go-name": "SchemaType" }, "title": { "type": "string", "x-go-name": "Title" }, "trigger_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "TriggerSchema" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "variable_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "VariableSchema" }, "variable_type": { "type": "boolean", "x-go-name": "VariableType" }, "version": { "type": "string", "x-go-name": "Version" }, "view_config": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "ViewConfig" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SchemaByTypeResponse": { "title": "SchemaByTypeResponse ...", "type": "object", "properties": { "data_schema": { "$ref": "#/components/schemas/Schema" }, "view_schema": { "$ref": "#/components/schemas/Schema" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "SchemaNewPostRequest": { "title": "SchemaNewPostRequest ...", "required": [ "data_schema" ], "type": "object", "properties": { "data_schema": { "$ref": "#/components/schemas/Schema" }, "view_schema": { "$ref": "#/components/schemas/Schema" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "SchemaNewPostResponse": { "title": "SchemaNewPostResponse ...", "type": "object", "properties": { "data_schema": { "$ref": "#/components/schemas/Schema" }, "view_schema": { "$ref": "#/components/schemas/Schema" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "SchemaPutRequest": { "title": "A SchemaPutRequest for one or more schema templates.", "type": "object", "properties": { "access_meta": { "$ref": "#/components/schemas/AccessMeta" }, "action_func": { "$ref": "#/components/schemas/ActionFunc" }, "attributes": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Attributes" }, "description": { "type": "string", "x-go-name": "Description" }, "group": { "type": "string", "x-go-name": "Group" }, "id": { "type": "string", "x-go-name": "SchemaID" }, "inherits": { "type": "object", "properties": {}, "x-go-name": "Inherits" }, "invisible": { "type": "boolean", "x-go-name": "Invisible" }, "is_internal": { "type": "boolean", "x-go-name": "IsInternal" }, "name": { "type": "string", "x-go-name": "Name" }, "output_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "OutputSchema" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "title": { "type": "string", "x-go-name": "Title" }, "trigger_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "TriggerSchema" }, "variable_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "VariableSchema" }, "version": { "type": "string", "x-go-name": "Version" }, "view_config": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "ViewConfig" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Serverless": { "title": "Serverless ...", "type": "object", "properties": { "cloud_type": { "type": "string", "x-go-name": "CloudType" }, "name": { "type": "string", "x-go-name": "Name" }, "region": { "type": "string", "x-go-name": "Region" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "ShareObjectPermissions": { "title": "ShareObjectPermissions ...", "type": "object", "properties": { "groups": { "type": "array", "description": "List of groups permissions", "items": { "$ref": "#/components/schemas/GroupPermission" }, "x-go-name": "GroupPermissions" }, "users": { "type": "array", "description": "List of users permissions", "items": { "$ref": "#/components/schemas/UserPermission" }, "x-go-name": "UserPermissions" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "StartPointOption": { "title": "StartPointOption ..", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "StartWorkflowResponse": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "definition_id": { "type": "string", "x-go-name": "DefinitionID" }, "id": { "type": "string", "x-go-name": "InstanceID" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "type": { "type": "string", "x-go-name": "Type" }, "version": { "type": "string", "x-go-name": "Version" } }, "description": "StartWorkflowResponse model", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "StartWorklfowConfigResponse": { "title": "StartWorklfowConfigResponse ...", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "DefinitionID" }, "input_variables": { "type": "array", "items": { "$ref": "#/components/schemas/VariableGetAllResponse" }, "x-go-name": "InputVariables" }, "intent_config": { "type": "object", "properties": {}, "x-go-name": "WFIntentConfig" }, "type_of_target_needed": { "type": "string", "x-go-name": "TargetType" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "wf_start_points": { "type": "array", "items": { "$ref": "#/components/schemas/StartPointOption" }, "x-go-name": "WFStartPoints" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "State": { "type": "string", "description": "DefinitionState", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Status": { "title": "Status ...", "type": "object", "properties": { "details": { "$ref": "#/components/schemas/StatusDetails" }, "prev_state": { "$ref": "#/components/schemas/State" }, "state": { "$ref": "#/components/schemas/State" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "StatusDetails": { "type": "object", "properties": { "code": { "type": "string", "x-go-name": "Code" }, "description": { "type": "string", "x-go-name": "Description" }, "message": { "type": "string", "x-go-name": "Message" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "SubmitInfo": { "title": "SubmitInfo ...", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Status" }, "submitted_for_review_version": { "type": "string", "x-go-name": "SubmittedVersion" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TableExport": { "title": "TableExport ...", "type": "object", "properties": { "access_type": { "type": "string", "x-go-name": "AccessType" }, "data_type": { "type": "string", "x-go-name": "DataType" }, "max_column_size": { "type": "integer", "format": "int64", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "format": "int64", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "format": "int64", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "format": "int64", "x-go-name": "MaxTableSize" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/TableRow" }, "x-go-name": "Rows" }, "table_type_id": { "type": "string", "x-go-name": "TableTypeID" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TableGetResponse": { "title": "TableGetResponse ...", "type": "object", "properties": { "data_type": { "type": "string", "x-go-name": "DataType" }, "name": { "type": "string", "x-go-name": "Name" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/TableRow" }, "x-go-name": "Rows" }, "rows_count": { "type": "integer", "format": "uint32", "x-go-name": "RowsCount" }, "table_id": { "type": "string", "x-go-name": "TableID" }, "table_type_id": { "type": "string", "x-go-name": "TableTypeID" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TablePostRequest": { "title": "TablePostRequest ...", "type": "object", "properties": { "max_column_size": { "type": "integer", "description": "Specify the columns size of the Table", "format": "int64", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "description": "Specify the columns of the Table", "format": "int64", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "description": "Specify the number of rows for table", "format": "int64", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "description": "Specify the table size of the Table", "format": "int64", "x-go-name": "MaxTableSize" }, "name": { "type": "string", "description": "Name of the Table", "x-go-name": "Name" }, "rows": { "type": "array", "description": "Add rows to the Table", "items": { "$ref": "#/components/schemas/TableRow" }, "x-go-name": "Rows" }, "table_type_id": { "type": "string", "description": "ID of the Table type", "x-go-name": "TableTypeID" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TableRow": { "type": "object", "properties": { "column_data": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "ColumnData" }, "row_id": { "type": "string", "x-go-name": "RowID" }, "suffix_id": { "type": "string", "x-go-name": "SuffixID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TableRowAttributeDescription": { "title": "TableRowAttributeDescription ...", "type": "object", "properties": { "key": { "type": "string", "x-go-name": "Key" }, "type": { "type": "string", "x-go-name": "Type" }, "value": { "type": "object", "properties": {}, "x-go-name": "Value" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TableRowDescription": { "title": "TableRowDescription ...", "type": "object", "properties": { "input_table": { "type": "string", "x-go-name": "InputTable" }, "row": { "type": "array", "items": { "$ref": "#/components/schemas/TableRowAttributeDescription" }, "x-go-name": "Row" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TableTypeExport": { "title": "TableTypeExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object", "properties": {} } }, "x-go-name": "ConsoleCols" }, "data_type": { "type": "string", "x-go-name": "DataType" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "inherits": { "type": "string", "x-go-name": "Inherits" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TableTypeSchemaResponse": { "title": "TableTypeSchemaResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_type": { "type": "string", "x-go-name": "DataType" }, "description": { "type": "string", "x-go-name": "Description" }, "display_name": { "type": "string", "x-go-name": "Name" }, "id": { "type": "string", "x-go-name": "SchemaID" }, "inherits": { "type": "string", "x-go-name": "Inherits" }, "owner": { "type": "string", "x-go-name": "Owner" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "row_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "RowSchema" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TakeActionRequest": { "title": "An TakeActionRequest model.", "type": "object", "properties": { "message": { "type": "string", "description": "Response message", "x-go-name": "Message" }, "prompt_response": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Prompt response", "x-go-name": "PromptResponse" }, "response": { "type": "string", "description": "Response", "x-go-name": "Response" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TargetDefinitionGetAllResponse": { "title": "TargetDefinitionGetAllResponse ...", "type": "object", "properties": { "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "def_access_meta": { "$ref": "#/components/schemas/DefAccessMeta" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "metadata": { "$ref": "#/components/schemas/TargetMetadata" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TargetDefinitionGetResponse": { "title": "TargetDefinitionGetResponse ...", "type": "object", "properties": { "adapter_id": { "type": "string", "x-go-name": "AdapterID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "def_access_meta": { "$ref": "#/components/schemas/DefAccessMeta" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "metadata": { "$ref": "#/components/schemas/TargetMetadata" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TargetDefinitionPostRequest": { "title": "TargetDefinitionPostRequest ...", "required": [ "name", "properties" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of the target", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of the target", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the target", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "View SchemaID of the target", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of the target", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Target.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TargetDefinitionPutRequest": { "title": "TargetDefinitionPutRequest ...", "required": [ "properties" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of the target", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of the target", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the target", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of the target", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TargetGroupDefExport": { "title": "TargetGroupDefExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetGroupProperties" }, "x-go-name": "Targets" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TargetGroupProperties": { "title": "TargetGroupProperties represents the specific target group attributes information\nIt holds the data/view schema id of targettype, target Ids and criteria for Target group", "type": "object", "properties": { "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/Expression" }, "x-go-name": "Criteria" }, "data_target_type": { "type": "string", "x-go-name": "DataTargetType" }, "include_all_targets": { "type": "boolean", "x-go-name": "IncludeAllTargets" }, "matched_target_ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "MatchedTargetIDs" }, "selected_target_ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "SelectedTargetIDs" }, "view_target_type": { "type": "string", "x-go-name": "ViewTargetType" } }, "description": "nolint:lll", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TargetGroupRequest": { "title": "TargetGroupRequest ...", "required": [ "name", "targets", "title" ], "type": "object", "properties": { "criteria": { "type": "array", "description": "TargetTypes common attributes", "items": { "$ref": "#/components/schemas/Expression" }, "x-go-name": "Criteria" }, "description": { "type": "string", "description": "Description of TargetGroup", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "TargetGroupID" }, "name": { "type": "string", "description": "Name of TargetGroup", "x-go-name": "Name" }, "schema_id": { "type": "string", "description": "ViewSchemaID of Schedule", "x-go-name": "ViewSchemaID" }, "targets": { "type": "array", "description": "Properties of Targets", "items": { "$ref": "#/components/schemas/TargetGroupProperties" }, "x-go-name": "TargetGroupProperties" }, "title": { "type": "string", "description": "Title of TargetGroup", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a TargetGroup.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TargetIDsRequest": { "title": "TargetIDsRequest ...", "type": "object", "properties": { "target_ids": { "type": "array", "description": "Target IDs", "items": { "type": "string" }, "x-go-name": "TargetIDs" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TargetMetadata": { "type": "object", "properties": { "sx_module_info": { "$ref": "#/components/schemas/ModuleInfo" } }, "description": "TargetMetadata maintains SecureX module data info", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TaskDateInfo": { "title": "TaskDateInfo ...", "type": "object", "properties": { "is_relative_time": { "type": "boolean", "x-go-name": "IsRelativeTime" }, "is_specified_date": { "type": "boolean", "x-go-name": "IsSpecifiedDate" }, "relative_time": { "$ref": "#/components/schemas/RelativeTime" }, "specified_date": { "type": "string", "x-go-name": "SpecifiedDate" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TaskPatchRequest": { "title": "An TaskPatchRequest model.", "type": "object", "properties": { "approval_choices": { "type": "array", "description": "Approval choices of task", "items": { "type": "string" }, "x-go-name": "ApprovalChoices" }, "assignees": { "type": "array", "description": "List of assignees of the task", "items": { "type": "string" }, "x-go-name": "Assignees" }, "description": { "type": "string", "description": "Task description", "x-go-name": "Description" }, "display_name": { "type": "string", "description": "Task name", "x-go-name": "Name" }, "due_date": { "$ref": "#/components/schemas/DueTaskDateInfo" }, "expiration_date": { "$ref": "#/components/schemas/TaskDateInfo" }, "expiration_status": { "type": "string", "description": "Task expiration status", "x-go-name": "ExpirationStatus" }, "minimum_approvals": { "type": "integer", "description": "Minimum Approvals for the task", "format": "uint32", "x-go-name": "MinimumApprovals" }, "priority": { "type": "string", "description": "Task priority", "x-go-name": "Priority" }, "subject_line": { "type": "string", "description": "Task subject line", "x-go-name": "SubjectLine" }, "task_message": { "type": "string", "description": "Approval message of task", "x-go-name": "ApprovalMessage" }, "task_owner": { "type": "string", "description": "Task owner", "x-go-name": "TaskOwner" }, "task_requestor": { "type": "string", "description": "Task requestor", "x-go-name": "TaskRequestor" }, "title": { "type": "string", "description": "Task title", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TaskPriority": { "type": "string", "description": "TaskPriority contains the Priority enum", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TasksPostRequest": { "title": "TasksPostRequest ...", "type": "object", "properties": { "types": { "type": "array", "description": "list of types to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "Types" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TasksSummaryResponse": { "title": "An TasksSummaryResponse model.", "type": "object", "properties": { "action_required": { "type": "integer", "format": "int64", "x-go-name": "ActionRequired" }, "assigned_to_me": { "type": "integer", "format": "int64", "x-go-name": "AssignedToMe" }, "completed": { "type": "integer", "format": "int64", "x-go-name": "Completed" }, "due_soon": { "type": "integer", "format": "int64", "x-go-name": "DueSoon" }, "expired": { "type": "integer", "format": "int64", "x-go-name": "Expired" }, "overdue": { "type": "integer", "format": "int64", "x-go-name": "Overdue" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TechVals": { "type": "object", "properties": { "data-maximal-size-in-GB": { "type": "integer", "format": "uint64", "x-go-name": "DataMaximalSizeInGB" }, "data-retention-in-days": { "type": "integer", "format": "uint64", "x-go-name": "DataRetentionInDays" }, "modules": { "$ref": "#/components/schemas/TechValsModules" } }, "description": "TechVals organization or tenant data retention information", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TechValsModules": { "title": "TechValsModules ...", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "Tenant": { "title": "Tenant ...", "type": "object", "properties": { "available_version": { "type": "string", "x-go-name": "AvailableVersion" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "deleted": { "type": "boolean", "x-go-name": "Deleted" }, "description": { "type": "string", "x-go-name": "Description" }, "disable_auto_upgrade": { "type": "boolean", "x-go-name": "DisableAutoUpgrade" }, "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "entitlement_summary": { "$ref": "#/components/schemas/EntitlementSummary" }, "externalId": { "type": "string", "x-go-name": "ExternalID" }, "features": { "type": "array", "items": { "type": "string" }, "x-go-name": "Features" }, "id": { "type": "string", "x-go-name": "TenantID" }, "is_xdr_enabled": { "type": "boolean", "x-go-name": "IsXDREnabled" }, "name": { "type": "string", "x-go-name": "Name" }, "parent_id": { "type": "string", "x-go-name": "ParentID" }, "status": { "$ref": "#/components/schemas/Status" }, "tenant_name": { "type": "string", "x-go-name": "TenantName" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "TenantPutRequest": { "title": "TenantPutRequest ...", "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "enabled": { "type": "boolean", "x-go-name": "Enabled" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "Tier": { "type": "object", "properties": { "enforce?": { "type": "boolean", "x-go-name": "Enforce" }, "quantity": { "type": "integer", "format": "uint64", "x-go-name": "Quantity" }, "title": { "$ref": "#/components/schemas/TierName" }, "unit": { "type": "string", "x-go-name": "Unit" } }, "description": "Tier organization or tenant tier level information", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TierName": { "title": "TierName ...", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TimeUnit": { "title": "TimeUnit ...", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "Trigger": { "title": "Trigger ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "id": { "type": "string", "x-go-name": "TriggerID" }, "invalid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "InvalidActions" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "ref_id": { "type": "string", "x-go-name": "RefID" }, "status": { "$ref": "#/components/schemas/TriggerStatus" }, "type": { "$ref": "#/components/schemas/TriggerType" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "ValidActions" }, "workflow_id": { "type": "string", "x-go-name": "WorkflowID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TriggerExport": { "title": "TriggerExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "lowercase_name": { "type": "string", "x-go-name": "LowercaseName" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "ref_id": { "type": "string", "x-go-name": "RefID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "$ref": "#/components/schemas/TriggerType" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" }, "workflow_id": { "type": "string", "x-go-name": "WorkflowID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TriggerPostRequest": { "required": [ "name", "ref_id", "type" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Trigger", "x-go-name": "Description" }, "disabled": { "type": "boolean", "description": "Disabled", "x-go-name": "Disabled" }, "name": { "type": "string", "description": "Name of Trigger", "x-go-name": "Name" }, "ref_id": { "type": "string", "description": "RefID, ID of an Event or ID of a Schedule", "x-go-name": "RefID" }, "type": { "$ref": "#/components/schemas/TriggerType" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "version": { "type": "string", "description": "Version", "x-go-name": "Version" } }, "description": "TriggerPostRequest struct for triggers post api", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TriggerPutRequest": { "required": [ "type" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Trigger", "x-go-name": "Description" }, "disabled": { "type": "boolean", "description": "Disabled", "x-go-name": "Disabled" }, "name": { "type": "string", "description": "Name of Trigger", "x-go-name": "Name" }, "ref_id": { "type": "string", "description": "RefID, ID of an Event or ID of an schedule", "x-go-name": "RefID" }, "type": { "$ref": "#/components/schemas/TriggerType" }, "version": { "type": "string", "description": "Version of Trigger", "x-go-name": "Version" } }, "description": "TriggerPutRequest struct for triggers post api", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "TriggerStatus": { "title": "TriggerStatus ...", "type": "object", "properties": { "details": { "$ref": "#/components/schemas/StatusDetails" }, "error_msg": { "type": "string", "x-go-name": "ErrorMsg" }, "prev_state": { "$ref": "#/components/schemas/State" }, "state": { "$ref": "#/components/schemas/State" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "TriggerType": { "title": "TriggerType ...", "type": "string", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "UpdateTableRowPostRequest": { "type": "object", "properties": { "rows_to_be_added": { "type": "array", "items": { "$ref": "#/components/schemas/UserTableRow" }, "x-go-name": "RowsToAdd" }, "rows_to_be_deleted": { "type": "array", "items": { "$ref": "#/components/schemas/UserTableRow" }, "x-go-name": "RowsToDelete" }, "rows_to_be_updated": { "type": "array", "items": { "$ref": "#/components/schemas/UserTableRow" }, "x-go-name": "RowsToUpdate" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "UserPermission": { "title": "UserPermission ...", "required": [ "id", "permissions" ], "type": "object", "properties": { "id": { "type": "string", "description": "An ID of user", "x-go-name": "ID" }, "permissions": { "type": "array", "description": "Permissions of the entity, Type of permissions can be: \"view\", \"run\", \"modify\", \"manage\"", "items": { "type": "string" }, "x-go-name": "Permissions" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "UserTableRow": { "type": "object", "properties": { "column_data": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "ColumnData" }, "previous_row_id": { "type": "string", "x-go-name": "PreviousRowID" }, "previous_suffix_id": { "type": "string", "x-go-name": "PreviousSuffixID" }, "row_id": { "type": "string", "x-go-name": "RowID" }, "suffix_id": { "type": "string", "x-go-name": "SuffixID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "Variable": { "title": "Variable ...", "required": [ "schema_id" ], "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "description": "ID of variable", "x-go-name": "VariableID" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "description": "View schema ID of variable, the value can be TargetTypeID for Table variables", "x-go-name": "ViewSchemaID" }, "table_id": { "type": "string", "description": "ID of table", "x-go-name": "TableID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "variable_def_id": { "type": "string", "description": "ID of variable", "x-go-name": "VariableDefID" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableContent": { "title": "VariableContent ...", "type": "object", "properties": { "description": { "type": "string", "description": "Description of variable", "x-go-name": "Description" }, "display_on_wizard": { "type": "boolean", "description": "Should the variable be shown on wizard\nUsed in input scope variables, if it is true, then variable is displayed on wizard", "x-go-name": "DisplayOnWizard" }, "is_invisible": { "type": "boolean", "x-go-name": "IsInvisible" }, "is_required": { "type": "boolean", "description": "Is the variable Required\nUsed in input string and secure string variable, if it is true, then string can't be emptly", "x-go-name": "IsRequired" }, "name": { "type": "string", "description": "Name of variable", "x-go-name": "Name" }, "scope": { "type": "string", "description": "Scope of variable. Scope can be 'input', 'global', 'local', 'static' or 'workflow'", "x-go-name": "Scope" }, "type": { "type": "string", "description": "Type of variable. Type can be 'datatype.boolean', 'datatype.string', 'datatype.number' or 'datatype.table'", "x-go-name": "Type" }, "value": { "type": "object", "properties": {}, "description": "Value of variable. Value can be a string, boolean, number or array", "x-go-name": "Value" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableExport": { "title": "VariableExport ...", "type": "object", "properties": { "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableGetAllResponse": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "VariableID" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "description": "VariableGetAllResponse model for variables", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "VariableGetResponse": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "VariableID" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "description": "VariableGetResponse model for variables", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "VariablePostRequest": { "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "description": "ViewSchemaID of variable", "x-go-name": "ViewSchemaID" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Properties of variable", "x-go-name": "UniqueName" } }, "description": "VariablePostRequest model for variables\nEither ViewSchemaID or Type or both can be provided to create a Variable.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariablePutRequest": { "title": "VariablePutRequest represents a payload for modifying an existing variable by its ID.", "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/VariableContent" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableStartPutRequest": { "title": "VariableStartPutRequest model for variables. Either id or name in the properties needs to be specified.", "type": "object", "properties": { "id": { "type": "string", "description": "Variable ID", "x-go-name": "VariableID" }, "properties": { "$ref": "#/components/schemas/VariableContent" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "VariableTypeExport": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/VariableTypeObjectKey" }, "x-go-name": "Keys" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "variable_type_schema_id": { "type": "string", "x-go-name": "VariableTypeSchemaUName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableTypeObjectKey": { "title": "VariableTypeObjectKey ...", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "VariableTypePostRequest": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/VariableTypeObjectKey" }, "x-go-name": "Keys" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "variable_type_id": { "type": "string", "x-go-name": "VariableTypeID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "VariableTypePutRequest": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/VariableTypeObjectKey" }, "x-go-name": "Keys" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WFExportObjects": { "title": "WFExportObjects ...", "type": "object", "properties": { "atomic_workflows": { "type": "array", "items": { "type": "string" }, "x-go-name": "AtomicWorkflows" }, "calendars": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CalendarExport" }, "x-go-name": "Calendars" }, "categories": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CategoryExport" }, "x-go-name": "Categories" }, "dependent_workflows": { "type": "array", "items": { "type": "string" }, "x-go-name": "DependentWorkflows" }, "events": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EventExport" }, "x-go-name": "Events" }, "module_targets": { "type": "array", "items": { "$ref": "#/components/schemas/XChangeModuleTargetMetadata" }, "x-go-name": "ModuleTargets" }, "module_targets_skip_list": { "type": "array", "items": { "type": "string" }, "x-go-name": "ModuleTargetsSkipList" }, "remotemetas": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RemoteMetaExport" }, "x-go-name": "RemoteMetas" }, "remotes_skip_list": { "type": "array", "items": { "type": "string" }, "x-go-name": "RemoteMetasSkipList" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RuleExport" }, "x-go-name": "Rules" }, "runtime_users": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DefinitionExport" }, "x-go-name": "RuntimeUsers" }, "runtime_users_skip_list": { "type": "array", "items": { "type": "string" }, "x-go-name": "RuntimeUsersSkipList" }, "schedules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ScheduleExport" }, "x-go-name": "Schedules" }, "subworkflows": { "type": "array", "items": { "$ref": "#/components/schemas/WFExportObjects" }, "x-go-name": "Subworkflows" }, "table_types": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TableTypeExport" }, "x-go-name": "TableTypes" }, "tables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TableExport" }, "x-go-name": "Tables" }, "target_groups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetGroupDefExport" }, "x-go-name": "TargetGroups" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DefinitionExport" }, "x-go-name": "Targets" }, "triggers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TriggerExport" }, "x-go-name": "Triggers" }, "variable_types": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VariableTypeExport" }, "x-go-name": "VariableTypes" }, "variables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VariableExport" }, "x-go-name": "GlobalVariables" }, "webhooks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/WebhookExport" }, "x-go-name": "Webhooks" }, "wf_rule_trigger": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/WorkflowRuleTriggerExport" }, "x-go-name": "WfRuleTrigMap" }, "workflow": { "$ref": "#/components/schemas/WorkflowDefExport" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WFExportPostRequest": { "title": "WFExportPostRequest ...", "type": "object", "properties": { "commit_message": { "type": "string", "x-go-name": "CommitMsg" }, "file_name": { "type": "string", "x-go-name": "FileName" }, "force": { "type": "boolean", "x-go-name": "Force" }, "target_id": { "type": "string", "x-go-name": "TargetID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WFInstancePaginationResponse": { "title": "WFInstancePaginationResponse ...", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowInstanceGetAllResponse" }, "x-go-name": "Results" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WFRuleResponse": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "id": { "type": "string", "x-go-name": "RuleID" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "rule_type": { "$ref": "#/components/schemas/RuleType" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/TriggerStatus" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WFVariableExport": { "title": "WFVariableExport ..", "type": "object", "properties": { "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WebhookExport": { "title": "WebhookExport ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WebhookGetAllResponse": { "title": "WebhookGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_schema_id": { "type": "string", "x-go-name": "DataSchemaID" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "WebhookID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" }, "view_schema_id": { "type": "string", "x-go-name": "ViewSchemaID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WebhookGetResponse": { "title": "WebhookGetResponse ...", "type": "object", "properties": { "api_key": { "type": "string", "x-go-name": "APIKey" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "WebhookID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "uri": { "type": "string", "x-go-name": "URI" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WebhookPostRequest": { "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Webhook", "x-go-name": "Description" }, "name": { "type": "string", "description": "Name of Webhook", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of webhook", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "ViewSchemaID of webhook", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of Webhook", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "description": "WebhookPostRequest struct for webhooks post api\nEither ViewSchemaID or Type or both can be provided to create an Webhook.", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WebhookPutRequest": { "title": "WebhookPutRequest ...", "required": [ "properties", "title" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of Webhook", "x-go-name": "Description" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of webhook", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of Webhook", "x-go-name": "Title" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WfVariablePutRequest": { "required": [ "id", "object_type", "properties", "schema_id" ], "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "description": "ID of variable", "x-go-name": "VariableID" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "$ref": "#/components/schemas/VariableContent" }, "schema_id": { "type": "string", "description": "View schema ID of variable, the value can be TargetTypeID for Table variables", "x-go-name": "ViewSchemaID" }, "table_id": { "type": "string", "description": "ID of table", "x-go-name": "TableID" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "description": "WfVariablePutRequest model for variables", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowDefExport": { "title": "WorkflowDefExport ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefExport" }, "x-go-name": "Actions" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "description": { "type": "string", "x-go-name": "Description" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "template_type": { "type": "string", "x-go-name": "TemplateType" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/WFVariableExport" }, "x-go-name": "WVariables" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowDefinitionGetAllResponse": { "title": "WorkflowDefinitionGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "permissions": { "type": "array", "items": { "type": "string" }, "x-go-name": "Permissions" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "started_on": { "type": "string", "format": "date-time", "x-go-name": "LastInstStartedOn" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" }, "workflow_valid": { "type": "boolean", "x-go-name": "WorkflowValid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowDefinitionPutRequest": { "title": "WorkflowDefinitionPutRequest ...", "type": "object", "properties": { "categories": { "type": "array", "description": "Categories associated with the workflow", "items": { "type": "string" }, "x-go-name": "Categories" }, "description": { "type": "string", "description": "Description of the workflow", "x-go-name": "Description" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "description": "Name of the workflow", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the workflow", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of the workflow", "x-go-name": "Title" }, "triggers": { "type": "array", "description": "Triggers of the workflow", "items": { "$ref": "#/components/schemas/Trigger" }, "x-go-name": "WFTriggers" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "description": "Is valid", "x-go-name": "Valid" }, "variables": { "type": "array", "description": "WFVariables of the workflow\n\nin: body", "items": { "$ref": "#/components/schemas/Variable" }, "x-go-name": "WFVariables" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowDefinitionPutRequestCommon": { "title": "WorkflowDefinitionPutRequestCommon ...", "type": "object", "properties": { "categories": { "type": "array", "description": "Categories associated with the workflow", "items": { "type": "string" }, "x-go-name": "Categories" }, "description": { "type": "string", "description": "Description of the workflow", "x-go-name": "Description" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "description": "Name of the workflow", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the workflow", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of the workflow", "x-go-name": "Title" }, "triggers": { "type": "array", "description": "Triggers of the workflow", "items": { "$ref": "#/components/schemas/Trigger" }, "x-go-name": "WFTriggers" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "description": "Is valid", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowDefinitionPutRequestV2": { "title": "WorkflowDefinitionPutRequestV2 ...", "type": "object", "properties": { "categories": { "type": "array", "description": "Categories associated with the workflow", "items": { "type": "string" }, "x-go-name": "Categories" }, "description": { "type": "string", "description": "Description of the workflow", "x-go-name": "Description" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "description": "Name of the workflow", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the workflow", "x-go-name": "Properties" }, "title": { "type": "string", "description": "Title of the workflow", "x-go-name": "Title" }, "triggers": { "type": "array", "description": "Triggers of the workflow", "items": { "$ref": "#/components/schemas/Trigger" }, "x-go-name": "WFTriggers" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "description": "Is valid", "x-go-name": "Valid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowDefinitionPutResponse": { "type": "object", "properties": { "invalid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "InvalidActions" }, "valid_actions": { "type": "array", "items": { "type": "string" }, "x-go-name": "ValidActions" }, "workflow": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } }, "description": "WorkflowDefinitionPutResponse model for workflow put request API", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowGetAllPaginationResponse": { "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionGetAllResponse" }, "x-go-name": "Results" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowInstanceBatchDeletePostReq": { "title": "WorkflowInstanceBatchDeletePostReq ...", "type": "object", "properties": { "owner": { "type": "array", "description": "list of owner IDs to filter by\nin: body", "items": { "type": "string" }, "x-go-name": "Owner" }, "wf_instance_ids": { "type": "array", "description": "workflow instance IDs", "items": { "type": "string" }, "x-go-name": "WFInstanceIDs" }, "workflow_ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "WorkflowIDs" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowInstanceGetAllResponse": { "title": "WorkflowInstanceGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "definition_id": { "type": "string", "x-go-name": "DefinitionID" }, "ended_on": { "type": "string", "format": "date-time", "x-go-name": "EndedOn" }, "id": { "type": "string", "x-go-name": "InstanceID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "root_workflow_id": { "type": "string", "x-go-name": "RootWorkflowID" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "started_by": { "type": "string", "x-go-name": "StartedBy" }, "started_on": { "type": "string", "format": "date-time", "x-go-name": "StartedOn" }, "status": { "$ref": "#/components/schemas/Status" }, "type": { "type": "string", "x-go-name": "Type" }, "ui_config": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "UIConfig" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowInstanceGetResponse": { "title": "WorkflowInstanceGetResponse ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionInstanceGetAllResponse" }, "x-go-name": "Actions" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "definition_id": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "x-go-name": "Description" }, "dynamic_map": { "$ref": "#/components/schemas/DynamicMap" }, "ended_on": { "type": "string", "format": "date-time", "x-go-name": "EndedOn" }, "id": { "type": "string", "x-go-name": "InstanceID" }, "name": { "type": "string", "x-go-name": "Name" }, "output": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Output" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "root_workflow_id": { "type": "string", "x-go-name": "RootWorkflowID" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "started_by": { "type": "string", "x-go-name": "StartedBy" }, "started_on": { "type": "string", "format": "date-time", "x-go-name": "StartedOn" }, "status": { "$ref": "#/components/schemas/Status" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "ui_config": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "UIConfig" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" }, "x-go-name": "WFVariables" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowLock": { "type": "object", "properties": { "locked": { "type": "boolean", "x-go-name": "Locked" }, "locked_by": { "type": "string", "x-go-name": "LockedBy" }, "message": { "type": "string", "x-go-name": "Message" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "WorkflowMetaData": { "title": "WorkflowMetaData ...", "required": [ "coa" ], "type": "object", "properties": { "coa": { "$ref": "#/components/schemas/CourseOfAction" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowMetadata": { "type": "object", "properties": { "coa": { "$ref": "#/components/schemas/CourseOfAction" }, "flags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Flags" }, "git_info": { "$ref": "#/components/schemas/GitInfo" }, "lock": { "$ref": "#/components/schemas/WorkflowLock" } }, "description": "WorkflowMetadata maintains miscellaneous metadata for the workflow", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "WorkflowRuleTriggerExport": { "type": "object", "properties": { "rule_unique_name": { "type": "string", "x-go-name": "RuleUniqueName" }, "trig_unique_name": { "type": "string", "x-go-name": "TriggerUniqueName" }, "wf_unique_name": { "type": "string", "x-go-name": "WfUniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowValidationGetResponse": { "title": "WorkflowValidationGetResponse ...", "type": "object", "properties": { "invalid_action_ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "InvalidStepIDs" }, "total_actions": { "type": "integer", "format": "uint32", "x-go-name": "TotalSteps" }, "total_valid": { "type": "integer", "format": "uint32", "x-go-name": "TotalValid" }, "total_variables": { "type": "integer", "format": "int64", "x-go-name": "TotalVariables" }, "workflow_valid": { "type": "boolean", "x-go-name": "WorkflowValid" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "WorkflowsInstancePostRequest": { "title": "WorkflowsInstancePostRequest ...", "type": "object", "properties": { "owner": { "type": "array", "description": "list of owner IDs to filter by\nin: body", "items": { "type": "string" }, "x-go-name": "Owner" }, "workflow_ids": { "type": "array", "description": "List of workflows to retrieve\n\nin: body", "items": { "type": "string" }, "x-go-name": "WorkflowIDs" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "WorkflowsPostRequest": { "title": "WorkflowsPostRequest ...", "type": "object", "properties": { "categories": { "type": "array", "description": "list of categories to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "Categories" }, "exclude_rule_types": { "type": "array", "description": "flag to be used in conjunction with rule_types. specify rule_types to be excluded.\n\"none\" if workflows should have atleast 1 rule_type\nallowed values: none, schedule.rule_schedule, amqp.rule_event, email.rule_event, approval_task.rule_event,\nwebhook.rule_event, kafka.rule_event, incident.rule_event, playbook_assignment.rule_event\nin: body", "items": { "type": "string" }, "x-go-name": "ExcludeRuleTypes" }, "owner": { "type": "array", "description": "list of owner IDs to filter by\nin: body", "items": { "type": "string" }, "x-go-name": "Owner" }, "rule_types": { "type": "array", "description": "list of rule_types to filter by. \"none\" if workflows with no rule_type needed\nallowed values: none, schedule.rule_schedule, amqp.rule_event, email.rule_event, approval_task.rule_event,\nwebhook.rule_event, kafka.rule_event, incident.rule_event, playbook_assignment.rule_event\nin: body", "items": { "type": "string" }, "x-go-name": "RuleTypes" }, "wf_metadata": { "$ref": "#/components/schemas/WorkflowMetaData" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "XChange": { "title": "XChange ...", "type": "object", "properties": { "author": { "type": "string", "x-go-name": "Author" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_schema_id": { "type": "string", "x-go-name": "DataSchemaID" }, "id": { "type": "string", "x-go-name": "XChangeID" }, "image": { "type": "string", "x-go-name": "Image" }, "install_count": { "type": "integer", "format": "uint32", "x-go-name": "InstallCount" }, "install_info": { "$ref": "#/components/schemas/InstallInfo" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "owner": { "type": "string", "x-go-name": "Owner" }, "path": { "type": "string", "x-go-name": "Path" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "publisher_info": { "$ref": "#/components/schemas/PublisherInfo" }, "rating": { "$ref": "#/components/schemas/RatingInfo" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "view_schema_id": { "type": "string", "x-go-name": "ViewSchemaID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "XChangeCategoryMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "name": { "type": "string", "x-go-name": "Name" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeCreateRequest": { "required": [ "base_type", "blurb", "contact_email", "properties", "title", "type", "workflow_ids" ], "type": "object", "properties": { "authored_by": { "type": "string", "description": "Author name", "x-go-name": "AuthoredBy" }, "base_type": { "type": "string", "description": "BaseType", "x-go-name": "BaseType" }, "blurb": { "type": "string", "description": "Short Description of XChange", "x-go-name": "Blurb" }, "categories": { "type": "array", "description": "Categories to which XChange belongs to", "items": { "type": "string" }, "x-go-name": "Categories" }, "contact_email": { "type": "string", "description": "ContactEmail to which XChange belongs to", "x-go-name": "ContactEmail" }, "external_links": { "type": "array", "description": "ExternalLinks for the XChange", "items": { "$ref": "#/components/schemas/ExternalLinks" }, "x-go-name": "ExternalLinks" }, "name": { "type": "string", "description": "Name of XChange", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the XChange", "x-go-name": "Properties" }, "release_note": { "type": "string", "description": "ReleaseNote for the xchange.", "x-go-name": "ReleaseNote" }, "schema_id": { "type": "string", "description": "View SchemaID of the XChange", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of XChange", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "type_of_submission": { "type": "string", "description": "Type of submission for XChange", "x-go-name": "TypeOfSubmission" }, "workflow_ids": { "type": "array", "description": "WorkflowIDs associated to the XChange object", "items": { "type": "string" }, "x-go-name": "WorkflowIDs" } }, "description": "XChangeCreateRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "XChangeGlobalVariableMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeIDOrder": { "type": "object", "properties": { "display_order": { "type": "integer", "format": "int64", "x-go-name": "DisplayOrder" }, "xchange_id": { "type": "string", "x-go-name": "XChangeID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "XChangeMetaData": { "type": "object", "properties": { "_rev": { "type": "integer", "format": "int64", "x-go-name": "Rev" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "module_targets": { "type": "array", "items": { "$ref": "#/components/schemas/XChangeModuleTargetMetadata" }, "x-go-name": "ModuleTargets" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeRuleMetadata" }, "x-go-name": "Rules" }, "runtime_users": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeRUMetadata" }, "x-go-name": "RuntimeUsers" }, "target_groups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeTargetGroupMetadata" }, "x-go-name": "TargetGroups" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeTargetMetadata" }, "x-go-name": "Targets" }, "tenant_id": { "type": "string", "x-go-name": "TenantID" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "variables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeGlobalVariableMetadata" }, "x-go-name": "Variables" }, "wf_variables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeWFVariableMetadata" }, "x-go-name": "WFVariables" }, "workflows": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeWFMetaData" }, "x-go-name": "Workflows" }, "xchange_categories": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeCategoryMetadata" }, "x-go-name": "XChangeCategories" }, "xchange_id": { "type": "string", "x-go-name": "XChangeID" }, "xchange_metadata_id": { "type": "string", "x-go-name": "XChangeMDID" } }, "description": "nolint:lll", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeModuleTargetMetadata": { "type": "object", "properties": { "external_id": { "type": "string", "x-go-name": "ExternalID" }, "module_type": { "type": "string", "x-go-name": "ModuleType" }, "target_id": { "type": "string", "x-go-name": "TargetID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangePaginationPostRequest": { "title": "XChangePaginationPostRequest ...", "type": "object", "properties": { "authorship_type": { "type": "array", "description": "list of authorship to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "AuthorshipType" }, "categories": { "type": "array", "description": "list of categories to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "Categories" }, "intent": { "type": "array", "description": "list of intent to get for. Acceptable values are \"pivot_menu\", \"incident_response\"\nin: body", "items": { "type": "string" }, "x-go-name": "Intent" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "XChangeRUMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeResponse": { "type": "object", "properties": { "response_summary": { "$ref": "#/components/schemas/ResponseSummary" }, "xchange": { "$ref": "#/components/schemas/IXChange" }, "xchange_metadata": { "$ref": "#/components/schemas/XChangeMetaData" } }, "description": "XChangeResponse object for XChange CRUD calls", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeRuleMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "description": { "type": "string", "x-go-name": "Description" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeTargetGroupMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetGroupProperties" }, "x-go-name": "Targets" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeTargetMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeUpdateRequest": { "required": [ "authored_by", "blurb", "contact_email", "properties", "title", "type_of_submission" ], "type": "object", "properties": { "authored_by": { "type": "string", "description": "Author name", "x-go-name": "AuthoredBy" }, "blurb": { "type": "string", "description": "Short Description of XChange", "x-go-name": "Blurb" }, "categories": { "type": "array", "description": "Categories to which XChange belongs to", "items": { "type": "string" }, "x-go-name": "Categories" }, "contact_email": { "type": "string", "description": "ContactEmail to which XChange belongs to", "x-go-name": "ContactEmail" }, "external_links": { "type": "array", "description": "ExternalLinks for the XChange", "items": { "$ref": "#/components/schemas/ExternalLinks" }, "x-go-name": "ExternalLinks" }, "name": { "type": "string", "description": "Name of XChange", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the XChange", "x-go-name": "Properties" }, "release_note": { "type": "string", "description": "ReleaseNote for the xchange.", "x-go-name": "ReleaseNote" }, "title": { "type": "string", "description": "Title of XChange", "x-go-name": "Title" }, "type_of_submission": { "type": "string", "description": "Type of submission for XChange", "x-go-name": "TypeOfSubmission" }, "workflow_ids": { "type": "array", "description": "WorkflowIDs associated to the XChange object", "items": { "type": "string" }, "x-go-name": "WorkflowIDs" } }, "description": "XChangeUpdateRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "XChangeWFMetaData": { "type": "object", "properties": { "atomic_workflows": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeWFMetaData" }, "x-go-name": "AtomicWorkflows" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "published_version": { "type": "string", "x-go-name": "PublishedVersion" }, "sub_workflows": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/XChangeWFMetaData" }, "x-go-name": "SubWorkflows" }, "title": { "type": "string", "x-go-name": "Title" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XChangeWFVariableMetadata": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "workflow_id": { "type": "string", "x-go-name": "WorkflowID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models" }, "XchangeGetAllPaginationResponse": { "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/PaginationLink" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/XChange" }, "x-go-name": "Results" }, "total_count": { "type": "integer", "format": "uint32", "x-go-name": "TotalCount" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "XchangeGetResponse": { "title": "XchangeGetResponse ...", "type": "object", "properties": { "_id": { "type": "string", "x-go-name": "XChangeID" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "blurb": { "type": "string", "x-go-name": "Blurb" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "data_schema_id": { "type": "string", "x-go-name": "DataSchemaID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "view_schema_id": { "type": "string", "x-go-name": "ViewSchemaID" } }, "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "comment": { "title": "Comment", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "commented_by": { "type": "string", "x-go-name": "CommentedBy" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "id": { "type": "string", "x-go-name": "CommentID" }, "message": { "type": "string", "x-go-name": "Message" }, "object_type": { "$ref": "#/components/schemas/LHObjType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "ref_base_type": { "type": "string", "x-go-name": "RefBaseType" }, "ref_id": { "type": "string", "x-go-name": "RefID" }, "ref_object_type": { "$ref": "#/components/schemas/LHObjType" }, "type": { "type": "string", "x-go-name": "Type" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "version": { "type": "string", "x-go-name": "Version" } }, "description": "This is a comment model.", "x-go-name": "Comment", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "createTableTypePutRequest": { "title": "CreateTableTypePutRequest ...", "type": "object", "properties": { "columns": { "type": "array", "description": "Specify columns for table type", "items": { "type": "object", "additionalProperties": { "type": "object", "properties": {} } }, "x-go-name": "ConsoleCols" }, "description": { "type": "string", "description": "Description of the Table Type", "x-go-name": "Description" }, "display_name": { "type": "string", "description": "Name of the Table Type", "x-go-name": "Name" }, "inherits": { "type": "string", "description": "Inherits", "x-go-name": "Inherits" }, "max_column_size": { "type": "integer", "description": "Define column size", "format": "int64", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "description": "Define Max columns for Table Type", "format": "int64", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "description": "Define MaxRows for Table Type", "format": "int64", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "description": "Define the table size", "format": "int64", "x-go-name": "MaxTableSize" } }, "x-go-name": "CreateTableTypePutRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "eventsRateLimitGetResponse": { "title": "EventsRateLimitGetResponse ...", "type": "object", "properties": { "daily_limit": { "type": "integer", "format": "uint64", "x-go-name": "DailyLimit" }, "end_processing_time": { "type": "string", "format": "date-time", "x-go-name": "EndProcessingTime" }, "limit_reached_at": { "type": "string", "x-go-name": "LimitReachedAt" }, "start_processing_time": { "type": "string", "format": "date-time", "x-go-name": "StartProcessingTime" }, "total_processed": { "type": "integer", "format": "uint64", "x-go-name": "TotalProcessed" } }, "x-go-name": "EventsRateLimitGetResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "getAllCalendarsParam": { "title": "CalendarPostRequest ...", "type": "object", "properties": { "types": { "type": "array", "description": "list of types to get for.\nin: body", "items": { "type": "string" }, "x-go-name": "Types" } }, "x-go-name": "CalendarPostRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "instancesSummaryResponse": { "title": "An InstancesSummaryResponse model.", "type": "object", "properties": { "canceled": { "type": "integer", "format": "int64", "x-go-name": "Canceled" }, "failed": { "type": "integer", "format": "int64", "x-go-name": "Failed" }, "paused": { "type": "integer", "format": "int64", "x-go-name": "Paused" }, "running": { "type": "integer", "format": "int64", "x-go-name": "Running" }, "success": { "type": "integer", "format": "int64", "x-go-name": "Success" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" }, "waiting_for_event": { "type": "integer", "format": "int64", "x-go-name": "WaitingForEvent" } }, "x-go-name": "InstancesSummaryResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "startWorklfowPostRequestPayload": { "type": "object", "properties": { "input_variables": { "type": "array", "description": "Input Variables information to start the workflow.\n\nin: body", "items": { "$ref": "#/components/schemas/VariableStartPutRequest" }, "x-go-name": "Variables" }, "intent_config": { "type": "object", "properties": {}, "description": "Intent config to start the workflow.\n\nin: body", "x-go-name": "WFIntentConfig" }, "runtime_user_id": { "type": "string", "description": "The runtime user ID to submit.\n\nin: body", "x-go-name": "WFRuntimeUserID" }, "start_point": { "type": "string", "description": "The workflow start point.\n\nin: body", "x-go-name": "WFStartPoint" }, "target_id": { "type": "string", "description": "The target ID to submit.\n\nin: body", "x-go-name": "WFTargetID" } }, "description": "StartWorklfowPostRequestPayload model", "x-go-name": "StartWorklfowPostRequestPayload", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "tableTypePostRequest": { "title": "TableTypePostRequest ...", "type": "object", "properties": { "columns": { "type": "array", "description": "Specify columns for table type", "items": { "type": "object", "additionalProperties": { "type": "object", "properties": {} } }, "x-go-name": "ConsoleCols" }, "description": { "type": "string", "description": "Description of the Table Type", "x-go-name": "Description" }, "display_name": { "type": "string", "description": "Name of the Table Type", "x-go-name": "Name" }, "inherits": { "type": "string", "description": "Inherits", "x-go-name": "Inherits" }, "max_column_size": { "type": "integer", "description": "Define column size", "format": "int32", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "description": "Define Max columns for Table Type", "format": "int32", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "description": "Define MaxRows for Table Type", "format": "int32", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "description": "Define the table size", "format": "int32", "x-go-name": "MaxTableSize" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "x-go-name": "TableTypePostRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "tableTypePutRequest": { "title": "TableTypePutRequest ...", "type": "object", "properties": { "TableTypeID": { "type": "string" }, "columns": { "type": "array", "description": "Specify columns for table type", "items": { "type": "object", "additionalProperties": { "type": "object", "properties": {} } }, "x-go-name": "ConsoleCols" }, "description": { "type": "string", "description": "Description of the Table Type", "x-go-name": "Description" }, "display_name": { "type": "string", "description": "Name of the Table Type", "x-go-name": "Name" }, "inherits": { "type": "string", "description": "Inherits", "x-go-name": "Inherits" }, "max_column_size": { "type": "integer", "description": "Define column size", "format": "int32", "x-go-name": "MaxColumnSize" }, "max_columns": { "type": "integer", "description": "Define Max columns for Table Type", "format": "int32", "x-go-name": "MaxColumns" }, "max_rows": { "type": "integer", "description": "Define MaxRows for Table Type", "format": "int32", "x-go-name": "MaxRows" }, "max_table_size": { "type": "integer", "description": "Define the table size", "format": "int32", "x-go-name": "MaxTableSize" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" } }, "x-go-name": "TableTypePutRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "targetGroupGetAllResponse": { "title": "TargetGroupGetAllResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "TargetGroupID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-name": "TargetGroupGetAllResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "targetGroupGetResponse": { "title": "TargetGroupGetResponse ...", "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "criteria": { "type": "object", "properties": {}, "x-go-name": "Criteria" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "TargetGroupID" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetGroupProperties" }, "x-go-name": "TargetGroupProperties" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" } }, "x-go-name": "TargetGroupGetResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "targetValidationResponse": { "title": "TargetValidationResponse ...", "type": "object", "properties": { "invalid_targets": { "type": "array", "items": { "type": "string" }, "x-go-name": "InValidTargets" }, "valid_targets": { "type": "array", "items": { "type": "string" }, "x-go-name": "ValidTargets" } }, "x-go-name": "TargetValidationResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "templateDefinitionPostRequest": { "title": "TemplateDefinitionPostRequest ...", "required": [ "base_type", "properties", "type" ], "type": "object", "properties": { "base_type": { "type": "string", "description": "BaseType", "x-go-name": "BaseType" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the template", "x-go-name": "Properties" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" } }, "description": "Type should be provided to create a Workflow.", "x-go-name": "TemplateDefinitionPostRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "variableTypeGetResponse": { "type": "object", "properties": { "base_type": { "type": "string", "x-go-name": "BaseType" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "id": { "type": "string", "x-go-name": "VariableTypeID" }, "inherits": { "type": "array", "items": { "type": "string" }, "x-go-name": "Inherits" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/VariableTypeObjectKey" }, "x-go-name": "Keys" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "variable_type_schema_id": { "type": "string", "x-go-name": "VariableTypeSchemaID" } }, "description": "VariableTypeGetResponse model for variabletype", "x-go-name": "VariableTypeGetResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "variableTypeResponse": { "type": "object", "properties": { "inherits": { "type": "array", "items": { "type": "string" }, "x-go-name": "Inherits" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/VariableTypeObjectKey" }, "x-go-name": "Keys" }, "name": { "type": "string", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "property_schema": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "PropertySchema" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "variable_type_id": { "type": "string", "x-go-name": "VariableTypeID" }, "variable_type_schema_id": { "type": "string", "x-go-name": "VariableTypeSchemaID" } }, "description": "VariableTypeResponse struct defines response for variable types", "x-go-name": "VariableTypeResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "workflowDefinitionGetResponse": { "title": "WorkflowDefinitionGetResponse ...", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDefinitionGetAllPropsResponse" }, "x-go-name": "Actions" }, "base_type": { "type": "string", "x-go-name": "BaseType" }, "categories": { "type": "array", "items": { "type": "string" }, "x-go-name": "Categories" }, "created_by": { "type": "string", "x-go-name": "CreatedBy" }, "created_on": { "type": "string", "format": "date-time", "x-go-name": "CreatedOn" }, "description": { "type": "string", "x-go-name": "Description" }, "dynamic_map": { "$ref": "#/components/schemas/DynamicMap" }, "id": { "type": "string", "x-go-name": "DefinitionID" }, "invalid_properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "InvalidProperties" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "x-go-name": "Name" }, "owner": { "type": "string", "x-go-name": "Owner" }, "permissions": { "type": "array", "items": { "type": "string" }, "x-go-name": "Permissions" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "x-go-name": "Properties" }, "schema_id": { "type": "string", "x-go-name": "ViewSchemaID" }, "started_on": { "type": "string", "format": "date-time", "x-go-name": "LastInstStartedOn" }, "status": { "$ref": "#/components/schemas/Status" }, "template_type": { "type": "string", "x-go-name": "TemplateType" }, "title": { "type": "string", "x-go-name": "Title" }, "type": { "type": "string", "x-go-name": "Type" }, "unique_name": { "type": "string", "x-go-name": "UniqueName" }, "updated_by": { "type": "string", "x-go-name": "UpdatedBy" }, "updated_on": { "type": "string", "format": "date-time", "x-go-name": "UpdatedOn" }, "valid": { "type": "boolean", "x-go-name": "Valid" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" }, "x-go-name": "WFVariables" }, "version": { "type": "string", "x-go-name": "Version" }, "workflow_valid": { "type": "boolean", "x-go-name": "WorkflowValid" } }, "x-go-name": "WorkflowDefinitionGetResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "workflowDefinitionPostRequest": { "title": "WorkflowDefinitionPostRequest ...", "required": [ "name", "properties" ], "type": "object", "properties": { "categories": { "type": "array", "description": "Categories associated with the workflow", "items": { "type": "string" }, "x-go-name": "Categories" }, "description": { "type": "string", "description": "Description of the Wrokflow", "x-go-name": "Description" }, "metadata": { "$ref": "#/components/schemas/WorkflowMetadata" }, "name": { "type": "string", "description": "Name of the Workflow", "x-go-name": "Name" }, "properties": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "Properties of the workflow", "x-go-name": "Properties" }, "schema_id": { "type": "string", "description": "View SchemaID of the workflow", "x-go-name": "ViewSchemaID" }, "title": { "type": "string", "description": "Title of the Workflow", "x-go-name": "Title" }, "type": { "type": "string", "description": "Type", "x-go-name": "Type" }, "unique_name": { "type": "string", "description": "Uniquename", "x-go-name": "UniqueName" }, "valid": { "type": "boolean", "description": "value of Valid", "x-go-name": "Valid" }, "variables": { "type": "array", "description": "WFVariables of the workflow\n\nin: body", "items": { "$ref": "#/components/schemas/Variable" }, "x-go-name": "WFVariables" } }, "description": "Either ViewSchemaID or Type or both can be provided to create a Workflow.", "x-go-name": "WorkflowDefinitionPostRequest", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/ao-libs/api/models" }, "workflowObjRefResponse": { "title": "WorkflowObjRefResponse response model.", "type": "object", "properties": { "actions": { "type": "object", "additionalProperties": { "type": "object", "properties": {} }, "description": "in: body", "x-go-name": "Actions" } }, "x-go-name": "WorkflowObjRefResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" }, "workflowSummaryResponse": { "title": "An WorkflowSummaryResponse model.", "type": "object", "properties": { "invalid": { "type": "integer", "format": "int64", "x-go-name": "Invalid" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" }, "valid": { "type": "integer", "format": "int64", "x-go-name": "Valid" } }, "x-go-name": "WorkflowSummaryResponse", "x-go-package": "bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models" } }, "responses": { "EventResponse": { "description": "An EventResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "MetaDataRefreshTokenResponse": { "description": "MetaDataRefreshTokenResponse response model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataRefreshToken" } } } }, "RemoteMetaResponse": { "description": "An RemoteMetaResponse response model\n\n# This is used for returning a response with a single remotemeta as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteMetaGetResponse" } } } }, "RemoteMetasResponse": { "description": "An RemoteMetasResponse response model\n\n# This is used for returning a response with a list of remotemeta as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteMetaGetAllResponse" } } } } }, "RuleResponse": { "description": "An RuleResponse response model\n\n# This is used for returning a response with a single rule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rule" } } } }, "WFInstanceResponse": { "description": "An ManageInstanceResponse response model\n\n# Return instance status", "headers": { "status": { "schema": { "type": "string" } } }, "content": {} }, "WebhookResponse": { "description": "An WebhookResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookGetResponse" } } } }, "actionDefinitonResponse": { "description": "An ActionDefinitonResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionGetResponse" } } } }, "actionPutResponse": { "description": "An ActionPutResponse response model\n\n# This is used for returning a response of an action as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionDefinitionPutResponse" } } } }, "calendarDefinitonResponse": { "description": "An CalendarDefinitonResponse response model\n\n# This is used to retutn a response of Calendar as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarGetResponse" } } } }, "calendarResponse": { "description": "An CalendarResponse response model\n\n# This is used to return response with a single calendar as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarGetAllResponse" } } } } }, "cancelWFInstanceResponse": { "description": "An CancelInstanceGetResponse response model\n\n# Return cancel instance operation status", "headers": { "status": { "schema": { "type": "string" } } }, "content": {} }, "categoryDefinitonResponse": { "description": "An CategoryDefinitonResponse response model\n\n# This is used to retutn a response of Category as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGetResponse" } } } }, "categoryResponse": { "description": "An CategoryResponse response model\n\n# This is used to return response with a single category as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryGetResponse" } } } } }, "changeOwnerResponse": { "description": "An ChangeOwnerResponse response model\n\n# This is used for returning a response for change owner of entity as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOwnerRequest" } } } }, "commentResponse": { "description": "CommentResponse\n\nThis is used for returning a comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } }, "eventsRateLimitResponse": { "description": "An EventsRateLimitResponse response model\n\n# This is used for returning a response for events rate limit as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eventsRateLimitGetResponse" } } } }, "eventsResponse": { "description": "An EventsResponse response model\n\n# This is used for returning a response with a single event as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } }, "exportToGitResponse": { "description": "An ExportToGitResponse response model\n\n# This is used for returning a response of export to a repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "exportToJSONResponse": { "description": "An ExportToJSONResponse response model\n\n# This is used for returning a response of export as a JSON object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WFExportObjects" } } } }, "getAllCalendarResponse": { "description": "An GetAllCalendarSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllCalendarPaginatedResponse" } } } }, "getAllCommentsResponse": { "description": "An GetAllCommentsSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllCommentsResponse" } } } }, "getAllRulesResponse": { "description": "An GetAllRulesSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllRulesPaginatedResponse" } } } }, "getAllTargetGroups": { "description": "The TargetGroupAllResponse response model\n\n# This is used for returning a response of target group as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/targetGroupGetAllResponse" } } } } }, "getAllTasksResponse": { "description": "An GetAllTasksSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllTasksResponse" } } } }, "getAllVarTypesResponse": { "description": "A GetAllVarTypesSwaggerResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllVariableTypesResponse" } } } }, "getDataViewSchemaResponse": { "description": "An GetDataViewSchemaResponse response model\n\n# This is used for returning a response of both data and view schema as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaByTypeResponse" } } } }, "getInstancesSummaryResponse": { "description": "An GetInstancesSummaryResponse model.\n\n# It will return a summary of workflows", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instancesSummaryResponse" } } } }, "getRatingResponse": { "description": "A GetRatingResponse response model\n\n# This is used for returning a response of rating as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingResponse" } } } }, "getRuleResponse": { "description": "An GetRuleResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllRuleResponse" } } } }, "getSchemaAllResponse": { "description": "An GetSchemaAllResponse response model\n\n# This is used for returning a response of schema as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Schema" } } } } }, "getSchemaResponse": { "description": "An GetSchemaResponse response model\n\n# This is used for returning a response of schema as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schema" } } } }, "getTasksSummaryResponse": { "description": "An GetTasksSummaryResponse model.\n\n# It will return a summary of tasks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TasksSummaryResponse" } } } }, "getWorkflowSummaryResponse": { "description": "An GetWorkflowSummaryResponse model.\n\n# It will return a summary of workflows", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowSummaryResponse" } } } }, "importFromJSONResponse": { "description": "An ImportFromJSONResponse response model\n\n# This is used for returning a response of export to a repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "noContent": { "description": "NoContent response model", "content": {} }, "readTaskResponse": { "description": "An ReadTaskResponse model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaskResponse" } } } }, "referenceResponse": { "description": "ReferenceResponse response model\n\nThis is used for returning a response with uses and/or usedby", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllReferences" } } } }, "runWorkflowResponse": { "description": "An RunWorkflowResponse response model\n\n# This is used for returning a response of workflow as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StartWorkflowResponse" } } } } }, "runtimeUserDefinitonResponse": { "description": "RuntimeUserDefinitonResponse response model\n\n# This is used for returning a response with a single runtime user as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetResponse" } } } }, "runtimeUserResponse": { "description": "RuntimeUserResponse response model\n\n# This is used for returning a response with a single runtime user as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RuntimeUserDefinitionGetAllResponse" } } } } }, "scheduleDefinitonResponse": { "description": "An ScheduleDefinitonResponse response model\n\n# This is used for returning a response of schedule as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleGetResponse" } } } }, "scheduleResponse": { "description": "An ScheduleResponse response model\n\n# This is used for returning a response with a single schedule as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleGetAllResponse" } } } } }, "schemaPostResponse": { "description": "An SchemaPostResponse response model\n\n# This is used for returning a response of schema as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaNewPostResponse" } } } }, "shareObjectPermissionsResponse": { "description": "An ShareObjectPermissionsResponse response model\n\n# This is used for returning a response for sharing of object permissions for user and groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareObjectPermissions" } } } }, "startWorklfowCfgResponse": { "description": "An StartWorklfowCfgResponse response model\n\n# This is used for returning a response of the workflow required parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartWorklfowConfigResponse" } } } }, "tableResponse": { "description": "A TableResponse model\n\n# This is used for returning a response of Table as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableGetResponse" } } } }, "tableTypeGetAllResponse": { "description": "A TableTypeGetAllResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTableTypeGetResponse" } } } } }, "tableTypeGetResponse": { "description": "A TableTypeGetResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTableTypeGetResponse" } } } }, "tableTypeSchemaGetResponse": { "description": "A TableTypeSchemaGetResponse model\n\n# This is used for returning a response of Target Type as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableTypeSchemaResponse" } } } }, "targetDefinitonAllResponse": { "description": "The TargetDefinitonAllResponse response model\n\n# This is used for returning a response of Targets as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TargetDefinitionGetAllResponse" } } } } }, "targetDefinitonResponse": { "description": "The TargetDefinitonResponse response model\n\n# This is used for returning a response of Target as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetDefinitionGetResponse" } } } }, "targetGroupGetResponse": { "description": "An TargetGroupResponse response model\n\n# This is used for returning a response for target group as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/targetGroupGetResponse" } } } }, "tenantGetAllResponse": { "description": "An TenantGetAllResponse response model\n\n# This is used for returning a response of Tenant and Its sub tenants as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } } } }, "tenantResponse": { "description": "The TenantResponse response model\n\n# This is used for returning a response of Tenant as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } }, "triggerGetAllResponse": { "description": "An TriggerGetAllResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Trigger" } } } } }, "triggerGetResponse": { "description": "An TriggerGetResponse response model\n\n# This is used for returning a response of Trigger as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Trigger" } } } }, "validationError": { "description": "A Error is a swagger response to represent error", "headers": { "code": { "schema": { "type": "integer", "format": "int64" } }, "description": { "schema": { "type": "string" } }, "message": { "schema": { "type": "string" } } }, "content": {} }, "variableDefinitonResponse": { "description": "VariableDefinitonResponse An VariableDefinitonResponse response model\n\nThis is used for returning a response of Variable as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableGetResponse" } } } }, "variableResponse": { "description": "An VariableResponse response model\n\nThis is used for returning a response with a single variable as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableGetAllResponse" } } } } }, "variableTypeAPIResponse": { "description": "VariableTypeAPIResponse VariableType response model\n\nThis is used for returning a response of Variable Type as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variableTypeResponse" } } } }, "webhooksResponse": { "description": "An WebhooksResponse response model\n\n# This is used for returning a response with a single webhook as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookGetAllResponse" } } } } }, "wfInstVariablesResponse": { "description": "An WfInstVariablesResponse response model\n\n# This is used for returning a response of workflow instance variables as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" } } } } }, "wfInstanceGetResponse": { "description": "An WFInstanceGetResponse response model\n\n# This is used for returning a response of workflow instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInstanceGetAllResponse" } } } }, "wfInstanceResponse": { "description": "An WFInstanceResponse response model\n\n# This is used for returning a response with a workflow instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WFInstancePaginationResponse" } } } }, "wfInstanceResponseV1": { "description": "An WFInstanceResponseV1 response model\n\n# This is used for returning a response with a workflow instance as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowInstanceGetAllResponse" } } } } }, "workflowActionInstanceResponse": { "description": "An WorkflowActionInstanceResponse response model\n\n# This is used for returning a response of action instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionInstanceGetResponse" } } } }, "workflowBatchGetResponse": { "description": "An WorkflowBatchGetResponse response model\n\n# This is used for returning a response of list of workflows as body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionGetAllResponse" } } } } }, "workflowDefinitonResponse": { "description": "A WorkflowDefinitonResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflowDefinitionGetResponse" } } } }, "workflowInstanceDeleteResponse": { "description": "An WorkflowInstanceDeleteResponse response model\n\n# Returns message not marked for deletion if workflow instances are in running state", "headers": { "message": { "schema": { "type": "string" } } }, "content": {} }, "workflowInstanceResponse": { "description": "An WorkflowInstanceResponse response model\n\n# This is used for returning a response of workflow instance as body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInstanceGetResponse" } } } }, "workflowLockResponse": { "description": "A WorkflowLockResponse model.", "content": {} }, "workflowResponse": { "description": "An WorkflowResponse response model\n\n# This is used for returning a response with a single workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowGetAllPaginationResponse" } } } }, "workflowResponseV1": { "description": "An WorkflowResponseV1 response model\n\n# This is used for returning a response with a single workflow as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionGetAllResponse" } } } } }, "workflowRulesResponse": { "description": "WorkflowRulesResponse response model\n\n# This is used for returning rules of a workflow", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/WFRuleResponse" } } } } } }, "workflowUpdateResponse": { "description": "A WorkflowUpdateResponse model\n\n# This is used for returning a response of Workflow as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDefinitionPutResponse" } } } }, "workflowValidationResponse": { "description": "An WorkflowValidationResponse response model\n\n# This is used for returning a response of action definition as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowValidationGetResponse" } } } }, "workflowVariablesResponse": { "description": "An WorkflowVariablesResponse response model\n\n# This is used for returning a response of workflow variables as a body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" } } } } }, "xchangeDefinitionResponse": { "description": "An XchangeDefinitionResponse response model\n\n# This is used to return a response of Xchange workflow or Xchange pack as a body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XchangeGetResponse" } } } }, "xchangeFeaturedResponse": { "description": "An XChangeFeaturedResponse response model\n\n# This is used for returning a collection of new featured xchanges in body", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/XChangeResponse" } } } } }, "xchangeGetAllResponse": { "description": "An XchangeGetAllResponse response model\n\n# This is used for returning a collection of xchange in body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XchangeGetAllPaginationResponse" } } } }, "xchangeReleaseNotesResponse": { "description": "An XchangeReleaseNotes response model\n\n# This is used to return a response of Xchange's release notes", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReleaseNote" } } } } } } }, "securitySchemes": { "oAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://visibility.amp.cisco.com/iroh/oauth2/token", "scopes": { "telemetry": "Collect application data for analytics", "integration:read": "Manage your modules", "private-intel:read": "Access Private Intelligence", "admin": "Provide admin privileges", "cognitive": "Cognitive Integration", "profile:read": "Get your profile information", "inspect:read": "Extract Observables and data from text", "asset": "Access and modify your assets", "event": "Read IROH Events", "feedback": "Submit Customer Feedback", "sse": "SSE Integration. Manage your Devices.", "registry": "Manage registry entries", "users:read": "Manage users of your organization", "investigation": "Perform threat analysis investigation", "invite:read": "Invite users into your organization", "casebook": "Access and modify your casebooks", "playbook": "Access and modify your playbooks", "orbital": "Orbital Integration.", "enrich:read": "Query your configured modules for threat intelligence", "oauth:read": "Manage OAuth2 Clients", "vault": "Grants access to Module Vaults", "response:read": "List and execute response actions using configured modules", "notification": "Receive notifications from integrations", "global-intel:read": "Access AMP Global Intelligence", "webhook": "Manage your Webhooks", "ao:read": "AO Integration." } } } } } }, "x-original-swagger-version": "2.0", "security": [ { "oAuth2": [ "integration:read", "private-intel:read", "profile:read", "inspect:read", "users:read", "invite:read", "enrich:read", "oauth:read", "response:read", "global-intel:read", "ao:read", "playbook:read" ] } ] }